Package net.sf.jett.tag

Class AnaTag

java.lang.Object

net.sf.jett.tag.BaseTag

net.sf.jett.tag.AnaTag

All Implemented Interfaces:

Tag

public class AnaTag
extends BaseTag

An AnaTag represents analytic values calculated from a List of values already exposed to the context. It uses jAgg functionality and exposes the results and AnalyticAggregators used for display later.

Attributes:

• Inherits all attributes from BaseTag.
• items (required): List
• analytics (required): String
• analyticsVar (optional): String
• valuesVar (required): String

Since:

0.9.0

Author:

Randy Gettman

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATTR_ANALYTICS	Attribute that specifies the List of analytic functions to use.
static java.lang.String	ATTR_ANALYTICS_VAR	Attribute that specifies the name of the List of exposed AnalyticAggregators.
static java.lang.String	ATTR_ITEMS	Attribute that specifies the List of items to analyze.
static java.lang.String	ATTR_VALUES_VAR	Attribute that specifies name of the List of exposed analytic values.

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

ATTR_ON_PROCESSED, SPEC_SEP

Constructor Summary

Constructors

Constructor	Description
AnaTag()

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()	Run an "analyze" operation on the specified AnalyticFunctions, get the results, and expose the analytic values and the AnalyticAggregators used.
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_ITEMS

public static final java.lang.String ATTR_ITEMS

Attribute that specifies the List of items to analyze.

See Also:

Constant Field Values

ATTR_ANALYTICS

public static final java.lang.String ATTR_ANALYTICS

Attribute that specifies the List of analytic functions to use.

See Also:

Constant Field Values

ATTR_ANALYTICS_VAR

public static final java.lang.String ATTR_ANALYTICS_VAR

Attribute that specifies the name of the List of exposed AnalyticAggregators.

See Also:

Constant Field Values

ATTR_VALUES_VAR

public static final java.lang.String ATTR_VALUES_VAR

Attribute that specifies name of the List of exposed analytic values.

See Also:

Constant Field Values

Constructor Detail

AnaTag

public AnaTag()

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 "items" attribute must be a List. The "analytics" attribute must be a semicolon-separated list of valid analytic specification strings. The "valuesVar" attribute must be a string that indicates the name to which the analytic values will be exposed in the Map of beans. The "analyticsVar" attribute must be a string that indicates the name of the List that contains all created AnalyticAggregators and to which that will be exposed in the Map of beans. The "ana" tag must have a body.

Overrides:

validateAttributes in class BaseTag

Throws:

TagParseException - If the attribute values are illegal or unacceptable.

process

public boolean process()

Run an "analyze" operation on the specified AnalyticFunctions, get the results, and expose the analytic values and the AnalyticAggregators used.

Specified by:

process in class BaseTag

Returns:

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