org.mmbase.bridge.jsp.taglib

Class CloudReferrerTag

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

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:

CloudInfoTag, ComponentTag, DataTypeTag, EditTag, FormatterTag, HasNodeManagerTag, HasNodeTag, HasRankTag, HasRelationManagerTag, HasSettingTag, InfoTag, ListContainerTag, LocaleTag, MayCreateTag, MayReadTag, MayTag, NodeReferrerTag, PropertyTag, QueryAddConstraintTag, QueryAgeConstraintTag, QueryAliasConstraintTag, QueryCompositeConstraintTag, QueryConstraintTag, QueryDistinctTag, QueryMaxNumberTag, QueryOffsetTag, QuerySortOrderTag, QueryTypeConstraintTag, SetPropertyTag, SettingTag, TransactionReferrerTag, TransactionTag, TreeHasPageTag, UrlTag

public abstract class CloudReferrerTag
extends ContextReferrerTag

Tags which are meant to live as a child of the CloudTag, could extend this class.

Version:

$Id$

Author:

Michiel Meeuwissen

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Attribute	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
CloudReferrerTag()

Method Summary

Modifier and Type	Method and Description
void	fillStandardParameters(Parameters p) Fill standard parameters like request, response, language and locale
protected CloudProvider	findCloudProvider() This method tries to find an ancestor object of type CloudProvider.
CloudProvider	findCloudProvider(boolean throwexception) This method tries to find an ancestor object of type CloudProvider.
protected CloudContext	getCloudContext()
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(String key)
protected Node	getNodeOrNull(String key) Gets a node from the context.
void	setCloud(String c) If there are more clouds to choose from, you can have a 'cloud' attribute in your tag, in wich you can indicate the id of the cloud you mean.

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

appendMoreParameters, doCatch, doEndTag, 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, 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.Tag

getParent, setParent

Field Detail

cloudId

protected Attribute cloudId

Constructor Detail

CloudReferrerTag

public CloudReferrerTag()

Method Detail

setCloud

public void setCloud(String c)
              throws javax.servlet.jsp.JspTagException

If there are more clouds to choose from, you can have a 'cloud' attribute in your tag, in wich you can indicate the id of the cloud you mean.

Throws:

javax.servlet.jsp.JspTagException

findCloudProvider

protected CloudProvider findCloudProvider()
                                   throws javax.servlet.jsp.JspTagException

This method tries to find an ancestor object of type CloudProvider.

Returns:

the CloudTag if found, else an exception.

Throws:

javax.servlet.jsp.JspTagException

findCloudProvider

public CloudProvider findCloudProvider(boolean throwexception)
                                throws javax.servlet.jsp.JspTagException

This method tries to find an ancestor object of type CloudProvider.

Returns:

the CloudProvider or null.

Throws:

javax.servlet.jsp.JspTagException

getCloudVar

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

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.

Returns:

a Cloud

Throws:

javax.servlet.jsp.JspTagException

getCloudContext

protected CloudContext getCloudContext()

Returns:

the cloud context

getNode

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

Throws:

javax.servlet.jsp.JspTagException

getNodeOrNull

protected Node getNodeOrNull(String key)
                      throws javax.servlet.jsp.JspTagException

Gets a node from the context.

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 ContextReferrerTag

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 ContextReferrerTag

Returns:

a locale when defined or otherwise the mmbase locale.

Throws:

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

Since:

MMBase-1.8