com.bea.content.manager.servlets.jsp.taglib
Class BaseTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      com.bea.content.manager.servlets.jsp.taglib.BaseTag

All Implemented Interfaces:

IterationTag, Serializable, Tag

Direct Known Subclasses:

GetNodeTag, GetPropertyTag, SearchTag

public abstract class BaseTag

extends TagSupport

The base class for all content tags.

This provides support for the failOnError, useCache, cacheScope, cacheId, and cacheTimeout parameters.

See Also:

Serialized Form

Field Summary

protected String	cacheId The cache id.
protected String	cacheScope The cache scope.
protected long	cacheTimeout The cache timeout.
protected boolean	failOnError Are we supposed to throw an exception on an error.
protected boolean	useCache Should this try to use the NodeCache

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

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

BaseTag()

Method Summary

String	getCacheId() Get the cacheId which should be used.
String	getCacheScope() Get the value of cacheScope.
String	getCacheTimeout() Get the value of cacheTimeout.
String	getFailOnError() Get the value of failOnError as a string.
HttpSession	getHttpSession() Get the current HttpSession.
String	getUseCache() Get the value of useCache.
String	getUserId() Get the user id of the current user.
void	release() Release the tag by setting everything to the default.
void	setCacheId(String s) Set the value of cacheId.
void	setCacheScope(String s) Sets the value of cacheScope.
void	setCacheTimeout(long l) Set the value of cacheTimeout.
void	setCacheTimeout(String v) Set the value of cacheTimeout.
void	setFailOnError(boolean b) Set the value of failOnError.
void	setFailOnError(String s) Set the value of failOnError.
void	setUseCache(boolean b) Set the value of useCache.
void	setUseCache(String s) Set the value of useCache.
static Map	toDictionary(String in) Convert a semi-colon separated of "name=value" pairs into a map.

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

doAfterBody, doEndTag, doStartTag, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cacheId

protected String cacheId

The cache id.

When accessing the cache, in general, if this is not set, then the ID should be used.

cacheScope

protected String cacheScope

The cache scope.

This should correspond to something which the NodeCache understands. The standard values are "application", "session", "page", and "request". The default is "session".

cacheTimeout

protected long cacheTimeout

The cache timeout.

failOnError

protected boolean failOnError

Are we supposed to throw an exception on an error.

useCache

protected boolean useCache

Should this try to use the NodeCache

Constructor Detail

BaseTag

public BaseTag()

Method Detail

getCacheId

public String getCacheId()

Get the cacheId which should be used.

getCacheScope

public String getCacheScope()

Get the value of cacheScope.

getCacheTimeout

public String getCacheTimeout()

Get the value of cacheTimeout.

getFailOnError

public String getFailOnError()

Get the value of failOnError as a string.

getHttpSession

public HttpSession getHttpSession()

Get the current HttpSession.

getUseCache

public String getUseCache()

Get the value of useCache.

getUserId

public String getUserId()

Get the user id of the current user.

release

public void release()

Release the tag by setting everything to the default.

setCacheId

public void setCacheId(String s)

Set the value of cacheId.

setCacheScope

public void setCacheScope(String s)

Sets the value of cacheScope.

setCacheTimeout

public void setCacheTimeout(long l)

Set the value of cacheTimeout.

setCacheTimeout

public void setCacheTimeout(String v)

Set the value of cacheTimeout.

setFailOnError

public void setFailOnError(boolean b)

Set the value of failOnError.

setFailOnError

public void setFailOnError(String s)

Set the value of failOnError.

setUseCache

public void setUseCache(boolean b)

Set the value of useCache.

setUseCache

public void setUseCache(String s)

Set the value of useCache.

toDictionary

public static Map toDictionary(String in)

Convert a semi-colon separated of "name=value" pairs into a map.