net.windward.tags
Class SetTag

net.windward.tags.BaseTag
  |
  +--net.windward.tags.SetTag

public class SetTag

extends BaseTag

Set a variable for later use. This outputs nothing, it just creates a local variable that can be referenced using ${name} later in other tags. This is different from the query tag in that this tag is used to perform text substitution while the query tag access data in the datasource.
This tag is passed the attributes value= and the ${name} construct can then be used to access the data in that node.
To delete a query, specify just the var= attribute. This tag represents a <wr:set ...> in the template. The possible usages are:

• <wr:set var="name" value="${stat.index}"/> which will store the value assigned to the var. If the value makes use of a var in a forEach tag, then this var is still good when the forEach loop is exited.
• <wr:set var="name"/> which will delete this set.

The full list of attributes is:

• var - required - identifies the node. This can be used in other tags using ${name}
• value - optional - the text that will be attached to the var.
• evaluate - optional - the text will be evaluated and the result will be attached to the var.

It is an error to enter <wr:set var="name" value="./name"> ... </wr:set>
This tag follows the jstl example of c:set.

Version:

4.0 May 23, 2005

Field Summary

static int	MODE_EVALUATE
static int	MODE_VALUE

Fields inherited from class net.windward.tags.BaseTag

CHART, COLUMN, DISPLAY_ALWAYS, DISPLAY_NOT_EMPTY, DISPLAY_NOT_NULL, ELSE, END_FOREACH, END_IF, END_LINK, END_MATRIX, ESCAPE, FOREACH, FUNCTION, HTML, IF, IMPORT, LINK, MATRIX, OUT, PROP_COMMENT, PROP_DATASOURCE, PROP_DEFAULT, PROP_DISPLAY, PROP_ENABLED, PROP_INPUT, PROP_PATTERN, PROP_TITLE, PROP_TYPE, PROP_VAR, PROP_WRAP, QUERY, ROW, SET, TAG_DISPLAY_DEFAULT, TAG_DISPLAY_SELECT, TAG_DISPLAY_TAG, TYPE_BITMAP, TYPE_BOTH, TYPE_CURRENCY, TYPE_DATE, TYPE_NUMBER, TYPE_PERCENT, TYPE_TIME, WRAP_BEHIND, WRAP_FRONT, WRAP_INLINE, WRAP_SQUARE

Constructor Summary

SetTag(java.util.Map map, boolean selfContained, boolean ignoreErrors)
Create an query element using the passed in map values.

Method Summary

net.windward.document.Element	dup(boolean sameRefId) Makes a duplicate of this object.
int	getXmlType() Returns which type of xml element this is.
java.lang.String	toDisplay(int type) How this node is displayed on the page when in a field.
java.lang.String	toString() Returns this object as a string in the format "query:...".
java.lang.String	toText() Converts this node back in to it's string representation in the document

Methods inherited from class net.windward.tags.BaseTag

containsAttribute, factory, factory, getAttribute, getAttributes, getBean, getDatasource, getIntAttribute, getLevel, getMode, getNode, getType, setLevel, setNode, toTagText

Field Detail

MODE_VALUE

public static final int MODE_VALUE

MODE_EVALUATE

public static final int MODE_EVALUATE

Constructor Detail

SetTag

public SetTag(java.util.Map map,
              boolean selfContained,
              boolean ignoreErrors)
       throws TagException

Create an query element using the passed in map values.

Parameters:

map - Must have a var, may have a value entry.

selfContained - Must be true.

ignoreErrors -

Throws:

TagException - thrown if illegal parameters passed in.

Method Detail

toText

public java.lang.String toText()
                        throws TagException

Converts this node back in to it's string representation in the document

Overrides:

toText in class BaseTag

Returns:

<wr:query ... /> type string.

toDisplay

public java.lang.String toDisplay(int type)

How this node is displayed on the page when in a field.

Overrides:

toDisplay in class BaseTag

Parameters:

type - One of the DISPLAY_* constants

Returns:

title, end of select, or <cmd> type string.

dup

public net.windward.document.Element dup(boolean sameRefId)

Makes a duplicate of this object. A deep clone is done so the new object shares nothing with the original object.

Parameters:

sameRefId -

Returns:

The new duplicate of this object

getXmlType

public int getXmlType()

Returns which type of xml element this is.

Overrides:

getXmlType in class BaseTag

Returns:

QUERY

toString

public java.lang.String toString()

Returns this object as a string in the format "query:...".

Returns:

A String listing this element.