Package net.sf.jett.parser

Class SheetNameMetadataParser

java.lang.Object

net.sf.jett.parser.MetadataParser

net.sf.jett.parser.SheetNameMetadataParser

public class SheetNameMetadataParser
extends MetadataParser

A SheetNameMetadataParser is a MetadataParser that disallows certain metadata keys that do not make sense when present as part of a sheet name.

Since:

0.9.1

Author:

Randy Gettman

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ABBR_INDEX_VAR	Abbreviation for MetadataParser.VAR_NAME_INDEXVAR.
static java.lang.String	ABBR_LIMIT	Abbreviation for MetadataParser.VAR_NAME_LIMIT.
static java.lang.String	ABBR_REPLACE_VALUE	Abbreviation for MetadataParser.VAR_NAME_REPLACE_VALUE.
static java.lang.String	ABBR_VAR_STATUS	Abbreviation for MetadataParser.VAR_NAME_VAR_STATUS.

Fields inherited from class net.sf.jett.parser.MetadataParser

VAR_NAME_COLLAPSE, VAR_NAME_COPY_RIGHT, VAR_NAME_EXTRA_ROWS, VAR_NAME_FIXED, VAR_NAME_GROUP_DIR, VAR_NAME_INDEXVAR, VAR_NAME_LEFT, VAR_NAME_LIMIT, VAR_NAME_ON_LOOP_PROCESSED, VAR_NAME_ON_PROCESSED, VAR_NAME_PAST_END_ACTION, VAR_NAME_REPLACE_VALUE, VAR_NAME_RIGHT, VAR_NAME_VAR_STATUS

Constructor Summary

Constructors

Constructor	Description
SheetNameMetadataParser()	Create a SheetNameMetadataParser.
SheetNameMetadataParser(java.lang.String metadataText)	Create a SheetNameMetadataParser object that will parse the given metadata text.

Method Summary

Modifier and Type	Method	Description
protected java.util.Map<java.lang.String,java.lang.String>	getAbbreviations()	This parser will recognize abbreviations in the returned map.
protected boolean	isRestricted(java.lang.String metadataKey)	Restricts many metadata keys that don't make sense in the context of a sheet name.

Methods inherited from class net.sf.jett.parser.MetadataParser

getCollapsingGroup, getColsLeft, getColsRight, getCopyingRight, getExtraRows, getFixed, getGroupDir, getIndexVarName, getLimit, getPastEndAction, getReplacementValue, getTagListener, getTagLoopListener, getVarStatusName, isDefiningCols, parse, setCell, setMetadataText

Methods inherited from class java.lang.Object

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

Field Detail

ABBR_INDEX_VAR

public static final java.lang.String ABBR_INDEX_VAR

Abbreviation for MetadataParser.VAR_NAME_INDEXVAR.

See Also:

Constant Field Values

ABBR_LIMIT

public static final java.lang.String ABBR_LIMIT

Abbreviation for MetadataParser.VAR_NAME_LIMIT.

See Also:

Constant Field Values

ABBR_REPLACE_VALUE

public static final java.lang.String ABBR_REPLACE_VALUE

Abbreviation for MetadataParser.VAR_NAME_REPLACE_VALUE.

See Also:

Constant Field Values

ABBR_VAR_STATUS

public static final java.lang.String ABBR_VAR_STATUS

Abbreviation for MetadataParser.VAR_NAME_VAR_STATUS.

See Also:

Constant Field Values

Constructor Detail

SheetNameMetadataParser

public SheetNameMetadataParser()

Create a SheetNameMetadataParser.

SheetNameMetadataParser

public SheetNameMetadataParser(java.lang.String metadataText)

Create a SheetNameMetadataParser object that will parse the given metadata text.

Parameters:

metadataText - The text of the metadata.

Method Detail

isRestricted

protected boolean isRestricted(java.lang.String metadataKey)

Restricts many metadata keys that don't make sense in the context of a sheet name.

Overrides:

isRestricted in class MetadataParser

Parameters:

metadataKey - The metadata key.

Returns:

true if it's restricted, else false.

getAbbreviations

protected java.util.Map<java.lang.String,java.lang.String> getAbbreviations()

This parser will recognize abbreviations in the returned map.

Overrides:

getAbbreviations in class MetadataParser

Returns:

A Map of abbreviations to metadata keys.