Package net.sf.jett.tag

Class SetTag

java.lang.Object

net.sf.jett.tag.BaseTag

net.sf.jett.tag.SetTag

All Implemented Interfaces:

Tag

public class SetTag
extends BaseTag

A SetTag has no direct effect on the resultant spreadsheet. It stores a new variable-value pair in the current beans map. The variable name must be a legal variable name in JEXL. Set the value to be any legal JEXL expression. This tag must be bodiless.

Attributes:

• Inherits all attributes from BaseTag.
• var (required): String
• value (required): Object
• display (optional): RichTextString

Since:

0.11.0

Author:

Randy Gettman

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATTR_DISPLAY	Attribute that specifies the display value of the cell after this tag has been processed, if any.
static java.lang.String	ATTR_VALUE	Attribute that specifies the value to set -- any object that can be specified in a legal JEXL expression.
static java.lang.String	ATTR_VAR	Attribute that specifies the name of the variable in the beans map to create or modify.

Fields inherited from class net.sf.jett.tag.BaseTag

ATTR_ON_PROCESSED, SPEC_SEP

Constructor Summary

Constructors

Constructor	Description
SetTag()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()	Returns this Tag's name.
protected java.util.List<java.lang.String>	getOptionalAttributes()	Returns a List of optional attribute names.
protected java.util.List<java.lang.String>	getRequiredAttributes()	Returns a List of required attribute names.
boolean	process()	Sets the given variable name to the given value.
void	validateAttributes()	Validates the attributes for this Tag.

Methods inherited from class net.sf.jett.tag.BaseTag

checkAttributes, clearBlock, deleteBlock, getAttributes, getContext, getLocation, getParentTag, getWorkbookContext, isBodiless, processTag, removeBlock, setAttributes, setBodiless, setContext, setParentTag, setWorkbookContext

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_VAR

public static final java.lang.String ATTR_VAR

Attribute that specifies the name of the variable in the beans map to create or modify.

See Also:

Constant Field Values

ATTR_VALUE

public static final java.lang.String ATTR_VALUE

Attribute that specifies the value to set -- any object that can be specified in a legal JEXL expression.

See Also:

Constant Field Values

ATTR_DISPLAY

public static final java.lang.String ATTR_DISPLAY

Attribute that specifies the display value of the cell after this tag has been processed, if any.

See Also:

Constant Field Values

Constructor Detail

SetTag

public SetTag()

Method Detail

getName

public java.lang.String getName()

Returns this Tag's name.

Returns:

This Tag's name.

getRequiredAttributes

protected java.util.List<java.lang.String> getRequiredAttributes()

Returns a List of required attribute names.

Overrides:

getRequiredAttributes in class BaseTag

Returns:

A List of required attribute names.

getOptionalAttributes

protected java.util.List<java.lang.String> getOptionalAttributes()

Returns a List of optional attribute names.

Overrides:

getOptionalAttributes in class BaseTag

Returns:

A List of optional attribute names.

validateAttributes

public void validateAttributes()
                        throws TagParseException

Validates the attributes for this Tag. The "var" and "value" attributes must be present.

Overrides:

validateAttributes in class BaseTag

Throws:

TagParseException - If the attribute values are illegal or unacceptable.

process

public boolean process()

Sets the given variable name to the given value.

Specified by:

process in class BaseTag

Returns:

Whether the first Cell in the Block associated with this Tag was processed.