org.mmbase.bridge.jsp.taglib
Class ListTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          org.mmbase.bridge.jsp.taglib.ContextReferrerTag
              org.mmbase.bridge.jsp.taglib.CloudReferrerTag
                  org.mmbase.bridge.jsp.taglib.NodeReferrerTag
                      org.mmbase.bridge.jsp.taglib.AbstractNodeProviderTag
                          org.mmbase.bridge.jsp.taglib.AbstractNodeListTag
                              org.mmbase.bridge.jsp.taglib.ListTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.BodyTag, ClusterNodeProvider, ContextProvider, FunctionContainerOrNodeProvider, javax.servlet.jsp.tagext.IterationTag, ListProvider, NodeProvider, QueryContainerOrListProvider, java.io.Serializable, javax.servlet.jsp.tagext.Tag, 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,v 1.47.2.3 2004/07/26 20:12:17 nico Exp $

Author:

Kees Jongenburger, Michiel Meeuwissen, Pierre van Rooden

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class org.mmbase.bridge.jsp.taglib.AbstractNodeListTag

AbstractNodeListTag.NodesAndTrim

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

Fields inherited from class org.mmbase.bridge.jsp.taglib.AbstractNodeProviderTag

nodeHelper

Fields inherited from class org.mmbase.bridge.jsp.taglib.NodeReferrerTag

parentNodeId

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.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

ListTag()

Method Summary

int	doStartTag() Performs the search
protected QueryContainer	getListContainer()
protected java.lang.String	getPath() To be overrided by related-tag
protected java.lang.String	getSearchNodes() To be overrided by related-tag
void	setContainer(java.lang.String c)
void	setDistinct(java.lang.String distinct)
void	setFields(java.lang.String fields)
void	setNodes(java.lang.String nodes) Sets the nodes to start the search with.
void	setPath(java.lang.String path)
void	setSearchdir(java.lang.String search) The search parameter, determines how directionality affects the search.

Methods inherited from class org.mmbase.bridge.jsp.taglib.AbstractNodeListTag

doAfterBody, doEndTag, doStartTagHelper, getContextContainer, getCurrent, getIndex, getIndexOffset, getNodesAndTrim, getNodesAndTrim, getReturnList, isChanged, remove, setComparator, setConstraints, setDirections, setMax, setOffset, setOrderby, setReturnValues, setReturnValues, size

Methods inherited from class org.mmbase.bridge.jsp.taglib.AbstractNodeProviderTag

fillVars, getModified, getNodeVar, setJspvar, setModified, setNodeVar

Methods inherited from class org.mmbase.bridge.jsp.taglib.NodeReferrerTag

findNodeProvider, findNodeProvider, getNode, setNode

Methods inherited from class org.mmbase.bridge.jsp.taglib.CloudReferrerTag

findCloudProvider, findCloudProvider, getCloud, getCloudContext, getCloudVar, getNode, getNodeOrNull, setCloud

Methods inherited from class org.mmbase.bridge.jsp.taglib.ContextReferrerTag

findParentTag, findParentTag, findParentTag, findParentTag, findWriter, findWriter, getAttribute, getAttributeBoolean, getAttributeInteger, getAttributeInteger, getAttributeValue, getContentTag, getContextProvider, getContextTag, getId, getLocale, getObject, getPageContext, getReferid, getString, getWriterValue, haveBody, release, setContext, setEscape, setId, setPageContext, 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

getNodeVar, setJspvar, setModified

Methods inherited from interface org.mmbase.bridge.jsp.taglib.TagIdentifier

getId

Methods inherited from interface javax.servlet.jsp.tagext.BodyTag

doInitBody, setBodyContent

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(java.lang.String fields)
               throws javax.servlet.jsp.JspTagException

Parameters:

fields - a comma separated list of fields of the nodes.

Throws:

javax.servlet.jsp.JspTagException

setContainer

public void setContainer(java.lang.String c)
                  throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

setNodes

public void setNodes(java.lang.String nodes)
              throws javax.servlet.jsp.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:

javax.servlet.jsp.JspTagException

setPath

public void setPath(java.lang.String path)
             throws javax.servlet.jsp.JspTagException

Parameters:

path - a comma separated list of nodeManagers

Throws:

javax.servlet.jsp.JspTagException

setSearchdir

public void setSearchdir(java.lang.String search)
                  throws javax.servlet.jsp.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:

javax.servlet.jsp.JspTagException

setDistinct

public void setDistinct(java.lang.String distinct)
                 throws javax.servlet.jsp.JspTagException

Parameters:

distinct - the selection query for the object we are looking for

Throws:

javax.servlet.jsp.JspTagException

getSearchNodes

protected java.lang.String getSearchNodes()
                                   throws javax.servlet.jsp.JspTagException

To be overrided by related-tag

Throws:

javax.servlet.jsp.JspTagException

getPath

protected java.lang.String getPath()
                            throws javax.servlet.jsp.JspTagException

To be overrided by related-tag

Throws:

javax.servlet.jsp.JspTagException

getListContainer

protected QueryContainer getListContainer()
                                   throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspTagException

Performs the search

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Throws:

javax.servlet.jsp.JspTagException