org.mmbase.bridge.jsp.taglib
Class ListTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by javax.servlet.jsp.tagext.BodyTagSupport
          extended by org.mmbase.bridge.jsp.taglib.ContextReferrerTag
              extended by org.mmbase.bridge.jsp.taglib.CloudReferrerTag
                  extended by org.mmbase.bridge.jsp.taglib.NodeReferrerTag
                      extended by org.mmbase.bridge.jsp.taglib.AbstractNodeProviderTag
                          extended by org.mmbase.bridge.jsp.taglib.AbstractNodeListTag
                              extended by org.mmbase.bridge.jsp.taglib.ListTag
All Implemented Interfaces:
Serializable, LoopTag, BodyTag, IterationTag, JspTag, Tag, TryCatchFinally, ClusterNodeProvider, FunctionContainerOrNodeProvider, ContextProvider, ListProvider, NodeProvider, TagIdentifier
Direct Known Subclasses:
RelatedTag

public class ListTag
extends AbstractNodeListTag
implements ClusterNodeProvider

ListTag, provides functionality for listing cluster nodes ('multilevel' search) in MMBase

Version:
$Id: ListTag.java 35335 2009-05-21 08:14:41Z michiel $
Author:
Kees Jongenburger, Michiel Meeuwissen, Pierre van Rooden
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.mmbase.bridge.jsp.taglib.AbstractNodeListTag
AbstractNodeListTag.NodesAndTrim
 
Nested classes/interfaces inherited from interface org.mmbase.bridge.jsp.taglib.ListProvider
ListProvider.ListProviderLoopTagStatus
 
Field Summary
protected  Attribute container
           
protected  Attribute distinct
           
protected  Attribute fields
           
protected  Attribute nodes
           
protected  Attribute path
           
protected  Attribute search
           
 
Fields inherited from class org.mmbase.bridge.jsp.taglib.AbstractNodeListTag
constraints, directions, listHelper, NOT_HANDLED, orderby, usetransaction
 
Fields inherited from class org.mmbase.bridge.jsp.taglib.AbstractNodeProviderTag
fieldEscaper, nodeHelper
 
Fields inherited from class org.mmbase.bridge.jsp.taglib.NodeReferrerTag
parentNodeId
 
Fields inherited from class org.mmbase.bridge.jsp.taglib.CloudReferrerTag
cloudId
 
Fields inherited from class org.mmbase.bridge.jsp.taglib.ContextReferrerTag
contextId, EVAL_BODY, helper, id, pageContextTag, referid, writerid
 
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
bodyContent
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Constructor Summary
ListTag()
           
 
Method Summary
 int doStartTag()
          Performs the search
protected  QueryContainer getListContainer()
           
protected  String getPath()
          To be overrided by related-tag
protected  String getSearchNodes()
          To be overrided by related-tag
 void setContainer(String c)
           
 void setDistinct(String distinct)
           
 void setFields(String fields)
           
 void setNodes(String nodes)
          Sets the nodes to start the search with.
 void setPath(String path)
           
 void setSearchdir(String search)
          The search parameter, determines how directionality affects the search.
 
Methods inherited from class org.mmbase.bridge.jsp.taglib.AbstractNodeListTag
doAfterBody, doEndTag, doFinally, doStartTagHelper, getContextContainer, getCurrent, getGeneratingQuery, getIndex, getIndexOffset, getLoopStatus, getNodeList, getNodesAndTrim, getNodesAndTrim, getReturnList, isChanged, remove, setAdd, setComparator, setConstraints, setDirections, setMax, setOffset, setOrderby, setRemove, setRetain, setReturnValues, setReturnValues, setUsetransaction, setVarStatus, size
 
Methods inherited from class org.mmbase.bridge.jsp.taglib.AbstractNodeProviderTag
fillVars, getNodeVar, setCommitonclose, setFieldescape, setJspvar, setNodeVar
 
Methods inherited from class org.mmbase.bridge.jsp.taglib.NodeReferrerTag
fillStandardParameters, findNode, findNodeProvider, findNodeProvider, getCloudVar, getLocale, getNode, getNode, getNodeFromPageContext, initTag, setElement, setNode
 
Methods inherited from class org.mmbase.bridge.jsp.taglib.CloudReferrerTag
findCloudProvider, findCloudProvider, getCloudContext, getNode, getNodeOrNull, setCloud
 
Methods inherited from class org.mmbase.bridge.jsp.taglib.ContextReferrerTag
appendMoreParameters, doCatch, findLoopOrQuery, findParentTag, findParentTag, findWriter, findWriter, getAttribute, getAttribute, getAttributeBoolean, getAttributeInteger, getAttributeInteger, getAttributeValue, getContentTag, getContextProvider, getContextTag, getCurrentBlock, getDefaultLocale, getEscapedValue, getFormTag, getId, getLocaleFromContext, getObject, getObjectConditional, getPageContext, getPageContextTag, getQuery, getReferid, getString, getTaglibVersion, getThreadPageContext, getTimeZone, getWriterValue, haveBody, release, setContext, setEscape, setId, setListdelimiter, setPageContext, setPageContextOnly, setReferid, setVartype, setWrite, setWriter
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doInitBody, getBodyContent, getPreviousOut, setBodyContent
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getParent, getValue, getValues, removeValue, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.mmbase.bridge.jsp.taglib.NodeProvider
getGeneratingQuery, getNodeVar, setCommitonclose, setJspvar
 
Methods inherited from interface org.mmbase.bridge.jsp.taglib.TagIdentifier
getId
 
Methods inherited from interface org.mmbase.bridge.jsp.taglib.ContextProvider
getPageContext
 
Methods inherited from interface javax.servlet.jsp.tagext.Tag
getParent, release, setPageContext, setParent
 

Field Detail

nodes

protected Attribute nodes

path

protected Attribute path

distinct

protected Attribute distinct

search

protected Attribute search

fields

protected Attribute fields

container

protected Attribute container
Constructor Detail

ListTag

public ListTag()
Method Detail

setFields

public void setFields(String fields)
               throws JspTagException
Parameters:
fields - a comma separated list of fields of the nodes.
Throws:
JspTagException

setContainer

public void setContainer(String c)
                  throws JspTagException
Throws:
JspTagException

setNodes

public void setNodes(String nodes)
              throws JspTagException
Sets the nodes to start the search with. The value '-1' interpreted as null, whcih indicates no predefined startnodes are sued (a more general search is conducted instead).

Parameters:
nodes - a node or a comma separated list of nodes.
Throws:
JspTagException

setPath

public void setPath(String path)
             throws JspTagException
Parameters:
path - a comma separated list of nodeManagers
Throws:
JspTagException

setSearchdir

public void setSearchdir(String search)
                  throws JspTagException
The search parameter, determines how directionality affects the search. Possible values are both, destination, source, either and all

Parameters:
search - the search value
Throws:
JspTagException

setDistinct

public void setDistinct(String distinct)
                 throws JspTagException
Parameters:
distinct - the selection query for the object we are looking for
Throws:
JspTagException

getSearchNodes

protected String getSearchNodes()
                         throws JspTagException
To be overrided by related-tag

Throws:
JspTagException

getPath

protected String getPath()
                  throws JspTagException
To be overrided by related-tag

Throws:
JspTagException

getListContainer

protected QueryContainer getListContainer()
                                   throws JspTagException
Throws:
JspTagException

doStartTag

public int doStartTag()
               throws JspTagException
Performs the search

Specified by:
doStartTag in interface Tag
Overrides:
doStartTag in class NodeReferrerTag
Throws:
JspTagException


MMBase 2.0-SNAPSHOT - null