org.mmbase.bridge.jsp.taglib
Class AbstractNodeListTag

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

All Implemented Interfaces:

BodyTag, ContextProvider, FunctionContainerOrNodeProvider, IterationTag, ListProvider, LoopTag, NodeProvider, Serializable, Tag, TagIdentifier

Direct Known Subclasses:

ListNodesTag, ListRelationsTag, ListTag, RelatedNodesTag

public abstract class AbstractNodeListTag

extends AbstractNodeProviderTag

implements BodyTag, ListProvider

AbstractNodeListTag, provides basic functionality for listing objects stored in MMBase

Version:

$Id: AbstractNodeListTag.java,v 1.73 2006/06/23 13:17:30 johannes Exp $

Author:

Kees Jongenburger, Michiel Meeuwissen, Pierre van Rooden

See Also:

Serialized Form

Nested Class Summary

protected static class

AbstractNodeListTag.NodesAndTrim

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

ListProvider.ListProviderLoopTagStatus

Field Summary

protected Attribute	constraints Holds the clause used to filter the list.
protected Attribute	directions Holds the direction to sort the list on (per field in orderby).
protected NodeListHelper	listHelper
protected static int	NOT_HANDLED
protected Attribute	orderby Holds the list of fields to sort the list on.

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

AbstractNodeListTag()

Method Summary

int	doAfterBody() Does everything needed on the afterbody tag of every NodeProvider.
int	doEndTag()
protected int	doStartTagHelper()
ContextContainer	getContextContainer()
Object	getCurrent()
Query	getGeneratingQuery() Returns a query which (a.o) results this Node.
int	getIndex()
int	getIndexOffset()
LoopTagStatus	getLoopStatus()
protected AbstractNodeListTag.NodesAndTrim	getNodesAndTrim(Query query)
protected AbstractNodeListTag.NodesAndTrim	getNodesAndTrim(Query query, int more)
protected NodeList	getReturnList()
boolean	isChanged() If you order a list, then the 'changed' property will be true if the field on which you order changed value.
void	release() Release all allocated resources.
void	remove() Removes the current item from the list.
void	setAdd(String c)
void	setComparator(String c)
void	setConstraints(String where) Sets the selection query
void	setDirections(String directions) Sets the direction to sort on
void	setMax(String max) Set the list maximum
void	setOffset(String o) Set the list offset
void	setOrderby(String orderby) Sets the fields to sort on.
void	setRemove(String c)
void	setRetain(String c)
protected int	setReturnValues(NodeList nodes) Creates the node iterator and sets appropriate variables (such as listsize) from a passed node list.
protected int	setReturnValues(NodeList nodes, boolean trim) Creates the node iterator and sets appropriate variables (such as listsize).
int	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, findNodeProvider, findNodeProvider, getLocale, getNode, setElement, setNode

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

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

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

findLoopOrQuery, findParentTag, findParentTag, findParentTag, findParentTag, findWriter, findWriter, getAttribute, getAttributeBoolean, getAttributeInteger, getAttributeInteger, getAttributeValue, getContentTag, getContextProvider, getContextTag, getDefaultLocale, getEscapedValue, getId, getObject, getObjectConditional, getPageContext, getPageContextTag, getReferid, getString, getTaglibVersion, getTimeZone, getWriterValue, haveBody, setContext, setEscape, setId, setListdelimiter, setPageContext, setReferid, setVartype, setWrite, setWriter

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

doInitBody, doStartTag, 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 javax.servlet.jsp.tagext.BodyTag

doInitBody, setBodyContent

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

doStartTag, getParent, setPageContext, setParent

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

getPageContext

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

getId

Field Detail

orderby

protected Attribute orderby

Holds the list of fields to sort the list on. The sort itself is implementation specific.

directions

protected Attribute directions

Holds the direction to sort the list on (per field in orderby). The sort itself is implementation specific.

constraints

protected Attribute constraints

Holds the clause used to filter the list. This is either a SQL-clause, with MMBase fields in brackets, a altavista-like search, preceded with the keyword ALTA, or a MMBase database node search, preceded with the keyord MMNODE. The filter itself is implementation specific (not all lists may implement this!).

listHelper

protected final NodeListHelper listHelper

NOT_HANDLED

protected static final int NOT_HANDLED

See Also:

Constant Field Values

Constructor Detail

AbstractNodeListTag

public AbstractNodeListTag()

Method Detail

getReturnList

protected NodeList getReturnList()

getCurrent

public Object getCurrent()

Specified by:

getCurrent in interface ListProvider

Returns:

the current item in a list

getIndex

public int getIndex()

Specified by:

getIndex in interface ListProvider

Returns:

the index of the current item in a list

getIndexOffset

public int getIndexOffset()

Specified by:

getIndexOffset in interface ListProvider

Returns:

The offset of the index (normally this will return 1)

remove

public void remove()

Description copied from interface: ListProvider

Removes the current item from the list.

Specified by:

remove in interface ListProvider

getGeneratingQuery

public Query getGeneratingQuery()

Description copied from interface: NodeProvider

Returns a query which (a.o) results this Node.

Specified by:

getGeneratingQuery in interface NodeProvider

Overrides:

getGeneratingQuery in class AbstractNodeProviderTag

setOrderby

public void setOrderby(String orderby)
                throws JspTagException

Sets the fields to sort on.

Parameters:

orderby - A comma separated list of fields on which the returned nodes should be sorted

Throws:

JspTagException

setDirections

public void setDirections(String directions)
                   throws JspTagException

Sets the direction to sort on

Parameters:

directions - the selection query for the object we are looking for direction

Throws:

JspTagException

setMax

public void setMax(String max)
            throws JspTagException

Set the list maximum

Parameters:

max - the max number of values returned

Throws:

JspTagException

setOffset

public void setOffset(String o)
               throws JspTagException

Set the list offset

Parameters:

o - Offset for the returned list.

Throws:

JspTagException

setComparator

public void setComparator(String c)
                   throws JspTagException

Throws:

JspTagException

setAdd

public void setAdd(String c)
            throws JspTagException

Throws:

JspTagException

setRetain

public void setRetain(String c)
               throws JspTagException

Throws:

JspTagException

setRemove

public void setRemove(String c)
               throws JspTagException

Throws:

JspTagException

setConstraints

public void setConstraints(String where)
                    throws JspTagException

Sets the selection query

Parameters:

where - the selection query

Throws:

JspTagException

getNodesAndTrim

protected final AbstractNodeListTag.NodesAndTrim getNodesAndTrim(Query query)
                                                          throws JspTagException

Throws:

JspTagException

getNodesAndTrim

protected AbstractNodeListTag.NodesAndTrim getNodesAndTrim(Query query,
                                                           int more)
                                                    throws JspTagException

Parameters:

more - How many more than max must be queried (if something will be subtracted later)

Returns:

true If successful

Throws:

JspTagException

Since:

MMBase-1.7

getContextContainer

public ContextContainer getContextContainer()
                                     throws JspTagException

Specified by:

getContextContainer in interface ContextProvider

Throws:

JspTagException

doStartTagHelper

protected int doStartTagHelper()
                        throws JspTagException

Throws:

JspTagException

setReturnValues

protected int setReturnValues(NodeList nodes)
                       throws JspTagException

Creates the node iterator and sets appropriate variables (such as listsize) from a passed node list. The list is assumed to be already sorted and trimmed.

Parameters:

nodes - the nodelist to create the iterator from

Returns:

EVAL_BODY_BUFFERED if the resulting list is not empty, SKIP_BODY if the list is empty. THis value should be passed as the result of {

Throws:

JspTagException

setReturnValues

protected int setReturnValues(NodeList nodes,
                              boolean trim)
                       throws JspTagException

Creates the node iterator and sets appropriate variables (such as listsize). Takes a node list, and trims it using the offset and max attributes if so indicated. The list is assumed to be already sorted.

Parameters:

nodes - the nodelist to create the iterator from

trim - if true, trim the list using offset and max (if false, it is assumed the calling routine already did so)

Returns:

EVAL_BODY_BUFFERED if the resulting list is not empty, SKIP_BODY if the list is empty. This value should be passed as the result of BodyTagSupport.doStartTag().

Throws:

JspTagException

doAfterBody

public int doAfterBody()
                throws JspTagException

Description copied from class: AbstractNodeProviderTag

Does everything needed on the afterbody tag of every NodeProvider. Normally this function would be overrided with one that has to call super.doAfterBody(). But not all servlet engines to call this function if there is no body. So, in that case it should be called from doEndTag, if the tag can do something without a body.

Specified by:

doAfterBody in interface IterationTag

Overrides:

doAfterBody in class AbstractNodeProviderTag

Throws:

JspTagException

doEndTag

public int doEndTag()
             throws JspTagException

Specified by:

doEndTag in interface Tag

Overrides:

doEndTag in class AbstractNodeProviderTag

Throws:

JspTagException

release

public void release()

Description copied from class: ContextReferrerTag

Release all allocated resources.

Specified by:

release in interface Tag

Overrides:

release in class AbstractNodeProviderTag

isChanged

public boolean isChanged()

If you order a list, then the 'changed' property will be true if the field on which you order changed value.

Specified by:

isChanged in interface ListProvider

Returns:

a boolean indicating wether the field on which was sorted is changed.

size

public int size()

Specified by:

size in interface ListProvider

Returns:

the size of the list

getLoopStatus

public LoopTagStatus getLoopStatus()

Specified by:

getLoopStatus in interface LoopTag