org.mmbase.bridge.jsp.taglib

Class NodeReferrerTag

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

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally

Direct Known Subclasses:

AbstractFunctionTag, AbstractNodeProviderTag, CountRelationsTag, CreateAliasTag, FieldReferrerTag, HasAliasTag, HasFieldTag, HasRelationsTag, InstanceOfTag, ListNodesContainerTag, ListRelationsContainerTag, MayWriteTag, NodeInfoTag, RelatedContainerTag, SetContextTag, StringListTag, TreeReferrerTag

public abstract class NodeReferrerTag
extends CloudReferrerTag

A tag which is a 'NodeReferrerTag's can be the child of a NodeProvider tag, which supplies a 'Node' to its child tags. For example the FieldTag, needs the use the Node of the parent NodeProviderTag and therefore would be a NodeReferrerTag.

Version:

$Id$

Author:

Michiel Meeuwissen

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Attribute	element
protected Attribute	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.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

Constructors

Constructor and Description
NodeReferrerTag()

Method Summary

Modifier and Type	Method and Description
int	doEndTag()
int	doStartTag()
void	fillStandardParameters(Parameters p) Fill standard parameters like request, response, language and locale
Node	findNode() As getNode() only with a different name, because taglib compilers can be confused otherwise.
NodeProvider	findNodeProvider() This method tries to find an ancestor object of type NodeProvider
NodeProvider	findNodeProvider(boolean throwexception) This method tries to find an ancestor object of type NodeProvider
Cloud	getCloudVar() Find the CloudProvider and return its cloud variable in one step.
Locale	getLocale() Get the locale which is defined by surrounding tags or the cloud
protected Node	getNode()
protected Node	getNode(boolean exception) Gets the Node variable from the parent NodeProvider.
protected Node	getNodeFromPageContext()
protected void	initTag()
void	setElement(String e) The element attribute is used to access elements of clusternodes.
void	setNode(String node) A NodeReferrer probably wants to supply the attribute 'node', to make it possible to refer to another node than the direct ancestor.

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, doFinally, 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, getTimer, getTimeZone, getWriterValue, haveBody, release, setContext, setEscape, setId, setJspvar, setListdelimiter, setPageContext, setPageContextOnly, setReferid, setVartype, setWrite, setWriter

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

doAfterBody, 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 javax.servlet.jsp.tagext.Tag

getParent, setParent

Field Detail

parentNodeId

protected Attribute parentNodeId

element

protected Attribute element

Constructor Detail

NodeReferrerTag

public NodeReferrerTag()

Method Detail

setElement

public void setElement(String e)
                throws javax.servlet.jsp.JspTagException

The element attribute is used to access elements of clusternodes.

Throws:

javax.servlet.jsp.JspTagException

Since:

MMBase-1.7.4

setNode

public void setNode(String node)
             throws javax.servlet.jsp.JspTagException

A NodeReferrer probably wants to supply the attribute 'node', to make it possible to refer to another node than the direct ancestor.

Throws:

javax.servlet.jsp.JspTagException

findNodeProvider

public NodeProvider findNodeProvider()
                              throws javax.servlet.jsp.JspTagException

This method tries to find an ancestor object of type NodeProvider

Returns:

the NodeProvider if found else an exception.

Throws:

javax.servlet.jsp.JspTagException

findNodeProvider

public NodeProvider findNodeProvider(boolean throwexception)
                              throws javax.servlet.jsp.JspTagException

This method tries to find an ancestor object of type NodeProvider

Returns:

the NodeProvider or null.

Throws:

javax.servlet.jsp.JspTagException

getNodeFromPageContext

protected Node getNodeFromPageContext()
                               throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

Since:

MMBase-1.8.5

getNode

protected Node getNode()
                throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

getNode

protected Node getNode(boolean exception)
                throws javax.servlet.jsp.JspTagException

Gets the Node variable from the parent NodeProvider.

Returns:

a org.mmbase.bridge.Node

Throws:

javax.servlet.jsp.JspTagException

Since:

MMBase-1.8.7

findNode

public final Node findNode()
                    throws javax.servlet.jsp.JspTagException

As getNode() only with a different name, because taglib compilers can be confused otherwise. (because of setNode(String))

Throws:

javax.servlet.jsp.JspTagException

Since:

MMBase-1.8.6

getCloudVar

public Cloud getCloudVar()
                  throws javax.servlet.jsp.JspTagException

Description copied from class: CloudReferrerTag

Find the CloudProvider and return its cloud variable in one step. And the result of findCloudProvider is stored, so invoking this function more often is better then invoking findCloudProvider every time.

Overrides:

getCloudVar in class CloudReferrerTag

Returns:

a Cloud

Throws:

javax.servlet.jsp.JspTagException

fillStandardParameters

public void fillStandardParameters(Parameters p)
                            throws javax.servlet.jsp.JspTagException

Description copied from class: ContextReferrerTag

Fill standard parameters like request, response, language and locale

Overrides:

fillStandardParameters in class CloudReferrerTag

Parameters:

p - the parameters

Throws:

javax.servlet.jsp.JspTagException - when parent tag is not found

getLocale

public Locale getLocale()
                 throws javax.servlet.jsp.JspTagException

Description copied from class: ContextReferrerTag

Get the locale which is defined by surrounding tags or the cloud

Overrides:

getLocale in class CloudReferrerTag

Returns:

a locale when defined or otherwise the mmbase locale.

Throws:

javax.servlet.jsp.JspTagException - when parent tag is not found

initTag

protected void initTag()

doStartTag

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

Specified by:

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

Overrides:

doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport

Throws:

javax.servlet.jsp.JspException

doEndTag

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

Specified by:

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

Overrides:

doEndTag in class ContextReferrerTag

Throws:

javax.servlet.jsp.JspTagException