railo.runtime.tag
Class Index

java.lang.Object
  extended by railo.runtime.ext.tag.TagImpl
      extended by railo.runtime.tag.Index
All Implemented Interfaces:
javax.servlet.jsp.tagext.Tag

public final class Index
extends TagImpl

Populates collections with indexed data.


Field Summary
static String[] EXTENSIONS
           
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
Index()
           
 
Method Summary
 int doEndTag()
           
 int doStartTag()
           
 void release()
           
 void setAction(String action)
          set the value action Specifies the index action.
 void setBody(String body)
          set the value body
 void setCategory(String listCategories)
           
 void setCategorytree(String categoryTree)
           
 void setCollection(String collection)
          set the value collection Specifies a collection name.
 void setCustom1(String custom1)
          set the value custom1 A custom field you can use to store data during an indexing operation.
 void setCustom2(String custom2)
          set the value custom2 A custom field you can use to store data during an indexing operation.
 void setCustom3(String custom3)
           
 void setCustom4(String custom4)
           
 void setExtensions(String extensions)
          set the value extensions
 void setExternal(boolean external)
          set the value external
 void setKey(String key)
          set the value key
 void setLanguage(String language)
          set the value language
 void setName(String name)
           
 void setPrefix(String prefix)
           
 void setQuery(String query)
          set the value query Specifies the name of the query against which the collection is generated.
 void setRecurse(boolean recurse)
          set the value recurse Yes or No.
 void setStatus(String status)
           
 void setThrowontimeout(boolean throwontimeout)
          set the value throwontimeout Yes or No.
 void setTimeout(double timeout)
           
 void setTitle(String title)
          set the value title Title for collection; Query column name for type and a valid query name; Permits searching collections by title or displaying a separate title from the key
 void setType(String type)
          set the value type Specifies the type of entity being indexed.
 void setUrlpath(String urlpath)
          set the value urlpath Specifies the URL path for files if type = "file" and type = "path".
 
Methods inherited from class railo.runtime.ext.tag.TagImpl
getParent, required, required, required, required, setPageContext, setPageContext, setParent
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EXTENSIONS

public static String[] EXTENSIONS
Constructor Detail

Index

public Index()
Method Detail

release

public void release()
Specified by:
release in interface javax.servlet.jsp.tagext.Tag
Overrides:
release in class TagImpl
See Also:
Tag.release()

setAction

public void setAction(String action)
set the value action Specifies the index action.

Parameters:
action - value to set

setUrlpath

public void setUrlpath(String urlpath)
set the value urlpath Specifies the URL path for files if type = "file" and type = "path". When the collection is searched with cfsearch, the pathname is automatically be prepended to filenames and returned as the url attribute.

Parameters:
urlpath - value to set

setType

public void setType(String type)
             throws PageException
set the value type Specifies the type of entity being indexed. Default is CUSTOM.

Parameters:
type - value to set
Throws:
PageException

setTimeout

public void setTimeout(double timeout)
                throws ApplicationException
Parameters:
timeout - the timeout in seconds
Throws:
ApplicationException

setThrowontimeout

public void setThrowontimeout(boolean throwontimeout)
set the value throwontimeout Yes or No. Specifies how timeout conditions are handled. If the value is Yes, an exception is generated to provide notification of the timeout. If the value is No, execution continues. Default is Yes.

Parameters:
throwontimeout - value to set

setName

public void setName(String name)

setTitle

public void setTitle(String title)
set the value title Title for collection; Query column name for type and a valid query name; Permits searching collections by title or displaying a separate title from the key

Parameters:
title - value to set

setCustom1

public void setCustom1(String custom1)
set the value custom1 A custom field you can use to store data during an indexing operation. Specify a query column name for type and a query name.

Parameters:
custom1 - value to set

setLanguage

public void setLanguage(String language)
set the value language

Parameters:
language - value to set

setExternal

public void setExternal(boolean external)
set the value external

Parameters:
external - value to set
Throws:
ApplicationException

setExtensions

public void setExtensions(String extensions)
                   throws PageException
set the value extensions

Parameters:
extensions - value to set
Throws:
PageException

setKey

public void setKey(String key)
set the value key

Parameters:
key - value to set

setCustom2

public void setCustom2(String custom2)
set the value custom2 A custom field you can use to store data during an indexing operation. Usage is the same as for custom1.

Parameters:
custom2 - value to set

setCustom3

public void setCustom3(String custom3)
Parameters:
custom3 - The custom3 to set.

setCustom4

public void setCustom4(String custom4)
Parameters:
custom4 - The custom4 to set.

setQuery

public void setQuery(String query)
set the value query Specifies the name of the query against which the collection is generated.

Parameters:
query - value to set

setCollection

public void setCollection(String collection)
                   throws PageException
set the value collection Specifies a collection name. If you are indexing an external collection external = "Yes", specify the collection name, including fully qualified path.

Parameters:
collection - value to set
Throws:
PageException

setRecurse

public void setRecurse(boolean recurse)
set the value recurse Yes or No. Yes specifies, if type = "Path", that directories below the path specified in key are included in the indexing operation.

Parameters:
recurse - value to set

setBody

public void setBody(String body)
set the value body

Parameters:
body - value to set

setCategory

public void setCategory(String listCategories)
Parameters:
category - the category to set
Throws:
ApplicationException

setCategorytree

public void setCategorytree(String categoryTree)
Parameters:
categoryTree - the categoryTree to set
Throws:
ApplicationException

setPrefix

public void setPrefix(String prefix)
Parameters:
prefix - the prefix to set

setStatus

public void setStatus(String status)
Parameters:
status - the status to set
Throws:
ApplicationException

doStartTag

public int doStartTag()
               throws PageException
Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class TagImpl
Throws:
SecurityException
PageException
See Also:
Tag.doStartTag()

doEndTag

public int doEndTag()
Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class TagImpl
See Also:
Tag.doEndTag()


Copyright © 2012 Railo