Package net.sf.jett.tag

Class NameTag

java.lang.Object

net.sf.jett.tag.BaseTag

net.sf.jett.tag.NameTag

All Implemented Interfaces:

Tag

public class NameTag
extends BaseTag

A NameTag indicates an association between an Excel named range and a JETT formula. Instead of the JETT formula being transformed into an Excel formula in the cell in which it's located, it will instead be applied to the specified named range. JETT does not verify that the dynamically generated expression is a valid Excel Formula. A NameTag must be bodiless.

Attributes:

• Inherits all attributes from BaseTag.
• name (required): String
• preferWorkbookScope (optional): boolean
• formula (required): String

Since:

0.8.0

Author:

Randy Gettman

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATTR_FORMULA	Attribute that specifies the JETT formula to be applied to the named range.
static java.lang.String	ATTR_NAME	Attribute that specifies the name of the named range.
static java.lang.String	ATTR_PREFER_WORKBOOK_SCOPE	Attribute that specifies whether to prefer a named range with workbook scope over a same-named named range with sheet scope.
static java.util.List<java.lang.String>	EXCEL_BUILT_IN_NAMES	A list of Excel built-in named range names.

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

ATTR_ON_PROCESSED, SPEC_SEP

Constructor Summary

Constructors

Constructor	Description
NameTag()

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()	There should be a JETT formula in the formula map, keyed by the location of this tag, referring to the JETT formula.
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

EXCEL_BUILT_IN_NAMES

public static final java.util.List<java.lang.String> EXCEL_BUILT_IN_NAMES

A list of Excel built-in named range names. These are hidden from Excel's "Name Manager", but they cause a conflict when JETT attempts to copy them from a source template sheet to a cloned template sheet. They appear to be covered by setting other sheet-related properties, e.g. "Print_Titles" is covered by setRepeatingRows and setRepeatingColumns. This is a blacklist JETT uses to bypass copying built-in names when cloning sheets.

ATTR_NAME

public static final java.lang.String ATTR_NAME

Attribute that specifies the name of the named range.

See Also:

Constant Field Values

ATTR_PREFER_WORKBOOK_SCOPE

public static final java.lang.String ATTR_PREFER_WORKBOOK_SCOPE

Attribute that specifies whether to prefer a named range with workbook scope over a same-named named range with sheet scope. The default is false, to prefer sheet scope over workbook scope.

See Also:

Constant Field Values

ATTR_FORMULA

public static final java.lang.String ATTR_FORMULA

Attribute that specifies the JETT formula to be applied to the named range. It must be enclosed in $[ and ] as normal for JETT formulas.

See Also:

Constant Field Values

Constructor Detail

NameTag

public NameTag()

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 "name" attribute must refer to an existing Excel named range name. The "formula" must be a JETT formula.

Overrides:

validateAttributes in class BaseTag

Throws:

TagParseException - If the attribute values are illegal or unacceptable.

process

public boolean process()

There should be a JETT formula in the formula map, keyed by the location of this tag, referring to the JETT formula. Replace the key with a different key based on the named range instead.

Specified by:

process in class BaseTag

Returns:

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