MetadataParser (Jett 0.11.0 API)

java.lang.Object
- net.sf.jett.parser.MetadataParser

Direct Known Subclasses:

SheetNameMetadataParser
```
public class MetadataParser
extends java.lang.Object
```
A MetadataParser parses metadata at the end of cell text.

Author:

Randy Gettman

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`VAR_NAME_COLLAPSE`	Metadata variable name specifying whether any Excel grouping created should be collapsed, defaulting to `false`.
`static java.lang.String`	`VAR_NAME_COPY_RIGHT`	Metadata variable name for copying right instead of down.
`static java.lang.String`	`VAR_NAME_EXTRA_ROWS`	Metadata variable name for extra rows in the Block.
`static java.lang.String`	`VAR_NAME_FIXED`	Metadata variable name for not shifting other content out of the way of a looping block.
`static java.lang.String`	`VAR_NAME_GROUP_DIR`	Metadata variable name specifying to create an Excel grouping for rows, columns, or no grouping.
`static java.lang.String`	`VAR_NAME_INDEXVAR`	Metadata variable name specifying the name of the zero-based "looping" variable.
`static java.lang.String`	`VAR_NAME_LEFT`	Metadata variable name for additional columns to the left in the Block.
`static java.lang.String`	`VAR_NAME_LIMIT`	Metadata variable name specifying a limit to the number of iterations processed.
`static java.lang.String`	`VAR_NAME_ON_LOOP_PROCESSED`	Metadata variable name specifying a `TagLoopListener` to listen for `TagLoopEvents`.
`static java.lang.String`	`VAR_NAME_ON_PROCESSED`	Metadata variable name specifying a `TagListener` to listen for `TagEvents`.
`static java.lang.String`	`VAR_NAME_PAST_END_ACTION`	Metadata variable name specifying the "past end action" to take whenever a `Collection` is exhausted before the end of iteration.
`static java.lang.String`	`VAR_NAME_REPLACE_VALUE`	Metadata variable name specifying the value with which to replace any expression that refers to a `Collection` that is exhausted before the end of iteration.
`static java.lang.String`	`VAR_NAME_RIGHT`	Metadata variable name for additional columns to the right in the Block.
`static java.lang.String`	`VAR_NAME_VAR_STATUS`	Metadata variable name specifying the name of the `LoopTagStatus` variable.

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected java.util.Map<java.lang.String,java.lang.String>`	`getAbbreviations()`	Returns a `Map` of abbreviations.
`java.lang.String`	`getCollapsingGroup()`	Returns the "collapse" lexeme.
`java.lang.String`	`getColsLeft()`	Returns the "columns left" lexeme.
`java.lang.String`	`getColsRight()`	Returns the "columns right" lexeme.
`java.lang.String`	`getCopyingRight()`	Returns the "copy right" lexeme.
`java.lang.String`	`getExtraRows()`	Returns the "extra rows" lexeme.
`java.lang.String`	`getFixed()`	Returns the "fixed" lexeme.
`java.lang.String`	`getGroupDir()`	Returns the "group dir" lexeme.
`java.lang.String`	`getIndexVarName()`	Returns the "looping" variable name.
`java.lang.String`	`getLimit()`	Returns the "limit" lexeme.
`java.lang.String`	`getPastEndAction()`	Returns the "past end action" lexeme.
`java.lang.String`	`getReplacementValue()`	Returns the replacement value, which is used to replace expressions that have been exhausted prior to the end of iteration, if the past end action is to replace expressions.
`java.lang.String`	`getTagListener()`	Returns the "tag listener" lexeme.
`java.lang.String`	`getTagLoopListener()`	Returns the "tag loop listener" lexeme.
`java.lang.String`	`getVarStatusName()`	Returns the "varStatus" lexeme.
`boolean`	`isDefiningCols()`	Returns whether column definitions are present.
`protected boolean`	`isRestricted(java.lang.String metadataKey)`	Determines whether the given metadata key is restricted -- not allowed in this context.
`void`	`parse()`	Parses the metadata text.
`void`	`setCell(org.apache.poi.ss.usermodel.Cell cell)`	Sets the `Cell` that contains the formula to be parsed.
`void`	`setMetadataText(java.lang.String metadataText)`	Sets the metadata text to the given metadata text and resets the parser.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VAR_NAME_EXTRA_ROWS
```
public static final java.lang.String VAR_NAME_EXTRA_ROWS
```
    Metadata variable name for extra rows in the Block.
    
    See Also:
    
    Constant Field Values
  - VAR_NAME_LEFT
```
public static final java.lang.String VAR_NAME_LEFT
```
    Metadata variable name for additional columns to the left in the Block.
    
    See Also:
    
    Constant Field Values
  - VAR_NAME_RIGHT
```
public static final java.lang.String VAR_NAME_RIGHT
```
    Metadata variable name for additional columns to the right in the Block.
    
    See Also:
    
    Constant Field Values
  - VAR_NAME_COPY_RIGHT
```
public static final java.lang.String VAR_NAME_COPY_RIGHT
```
    Metadata variable name for copying right instead of down. This is ignored if neither "left" nor "right" is specified.
    
    See Also:
    
    Constant Field Values
  - VAR_NAME_FIXED
```
public static final java.lang.String VAR_NAME_FIXED
```
    Metadata variable name for not shifting other content out of the way of a looping block. This turns on the implicit version of the "fixed" attribute of looping tags.
    
    See Also:
    
    Constant Field Values
  - VAR_NAME_PAST_END_ACTION
```
public static final java.lang.String VAR_NAME_PAST_END_ACTION
```
    Metadata variable name specifying the "past end action" to take whenever a Collection is exhausted before the end of iteration.
    
    Since:
    
    0.2.0
    
    See Also:
    
    Constant Field Values
  - VAR_NAME_REPLACE_VALUE
```
public static final java.lang.String VAR_NAME_REPLACE_VALUE
```
    Metadata variable name specifying the value with which to replace any expression that refers to a Collection that is exhausted before the end of iteration. This defaults to an empty string "". This is only relevant if the past end action is to replace expressions.
    
    Since:
    
    0.7.0
    
    See Also:
    
    Constant Field Values
  - VAR_NAME_GROUP_DIR
```
public static final java.lang.String VAR_NAME_GROUP_DIR
```
    Metadata variable name specifying to create an Excel grouping for rows, columns, or no grouping.
    
    Since:
    
    0.2.0
    
    See Also:
    
    Constant Field Values
  - VAR_NAME_COLLAPSE
```
public static final java.lang.String VAR_NAME_COLLAPSE
```
    Metadata variable name specifying whether any Excel grouping created should be collapsed, defaulting to false.
    
    Since:
    
    0.2.0
    
    See Also:
    
    Constant Field Values
  - VAR_NAME_ON_LOOP_PROCESSED
```
public static final java.lang.String VAR_NAME_ON_LOOP_PROCESSED
```
    Metadata variable name specifying a TagLoopListener to listen for TagLoopEvents.
    
    Since:
    
    0.3.0
    
    See Also:
    
    Constant Field Values
  - VAR_NAME_ON_PROCESSED
```
public static final java.lang.String VAR_NAME_ON_PROCESSED
```
    Metadata variable name specifying a TagListener to listen for TagEvents.
    
    Since:
    
    0.3.0
    
    See Also:
    
    Constant Field Values
  - VAR_NAME_INDEXVAR
```
public static final java.lang.String VAR_NAME_INDEXVAR
```
    Metadata variable name specifying the name of the zero-based "looping" variable.
    
    Since:
    
    0.3.0
    
    See Also:
    
    Constant Field Values
  - VAR_NAME_LIMIT
```
public static final java.lang.String VAR_NAME_LIMIT
```
    Metadata variable name specifying a limit to the number of iterations processed.
    
    Since:
    
    0.3.0
    
    See Also:
    
    Constant Field Values
  - VAR_NAME_VAR_STATUS
```
public static final java.lang.String VAR_NAME_VAR_STATUS
```
    Metadata variable name specifying the name of the LoopTagStatus variable.
    
    Since:
    
    0.9.1
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MetadataParser
```
public MetadataParser()
```
    Create a MetadataParser.
  - MetadataParser
```
public MetadataParser(java.lang.String metadataText)
```
    Create a MetadataParser object that will parse the given metadata text.
    
    Parameters:
    
    metadataText - The text of the metadata.
- Method Detail
  - setCell
```
public void setCell(org.apache.poi.ss.usermodel.Cell cell)
```
    Sets the Cell that contains the formula to be parsed.
    
    Parameters:
    
    cell - The Cell.
    
    Since:
    
    0.7.0
  - setMetadataText
```
public void setMetadataText(java.lang.String metadataText)
```
    Sets the metadata text to the given metadata text and resets the parser.
    
    Parameters:
    
    metadataText - The new metadata text.
  - parse
```
public void parse()
```
    Parses the metadata text.
  - isRestricted
```
protected boolean isRestricted(java.lang.String metadataKey)
```
    Determines whether the given metadata key is restricted -- not allowed in this context. Subclasses can override this method to implement their own restricted lists. This implementation doesn't restrict anything - it always returns false.
    
    Parameters:
    
    metadataKey - The metadata key.
    
    Returns:
    
    true if it's restricted, else false.
    
    Since:
    
    0.9.1
  - getAbbreviations
```
protected java.util.Map<java.lang.String,java.lang.String> getAbbreviations()
```
    Returns a Map of abbreviations. The map's keys are the abbreviations, and the values are the metadata keys.
    
    Returns:
    
    A Map of abbreviations, null means no abbreviations are permitted.
    
    Since:
    
    0.9.1
  - getExtraRows
```
public java.lang.String getExtraRows()
```
    Returns the "extra rows" lexeme.
    
    Returns:
    
    The "extra rows" lexeme.
  - getColsLeft
```
public java.lang.String getColsLeft()
```
    Returns the "columns left" lexeme.
    
    Returns:
    
    The "columns left" lexeme.
  - getColsRight
```
public java.lang.String getColsRight()
```
    Returns the "columns right" lexeme.
    
    Returns:
    
    The "columns right" lexeme.
  - isDefiningCols
```
public boolean isDefiningCols()
```
    Returns whether column definitions are present.
    
    Returns:
    
    Whether column definitions are present.
  - getCopyingRight
```
public java.lang.String getCopyingRight()
```
    Returns the "copy right" lexeme.
    
    Returns:
    
    The "copy right" lexeme.
  - getFixed
```
public java.lang.String getFixed()
```
    Returns the "fixed" lexeme.
    
    Returns:
    
    The "fixed" lexeme.
  - getPastEndAction
```
public java.lang.String getPastEndAction()
```
    Returns the "past end action" lexeme.
    
    Returns:
    
    The "past end action" lexeme.
    
    Since:
    
    0.2.0
  - getReplacementValue
```
public java.lang.String getReplacementValue()
```
    Returns the replacement value, which is used to replace expressions that have been exhausted prior to the end of iteration, if the past end action is to replace expressions.
    
    Returns:
    
    The replacement value, which defaults to an empty string "".
    
    Since:
    
    0.7.0
  - getGroupDir
```
public java.lang.String getGroupDir()
```
    Returns the "group dir" lexeme.
    
    Returns:
    
    The "group dir" lexeme.
    
    Since:
    
    0.2.0
  - getCollapsingGroup
```
public java.lang.String getCollapsingGroup()
```
    Returns the "collapse" lexeme.
    
    Returns:
    
    The "collapse" lexeme.
    
    Since:
    
    0.2.0
  - getTagLoopListener
```
public java.lang.String getTagLoopListener()
```
    Returns the "tag loop listener" lexeme.
    
    Returns:
    
    The "tag loop listener" lexeme.
    
    Since:
    
    0.3.0
  - getTagListener
```
public java.lang.String getTagListener()
```
    Returns the "tag listener" lexeme.
    
    Returns:
    
    The "tag listener" lexeme.
    
    Since:
    
    0.3.0
  - getIndexVarName
```
public java.lang.String getIndexVarName()
```
    Returns the "looping" variable name.
    
    Returns:
    
    The "looping" variable name.
    
    Since:
    
    0.3.0
  - getLimit
```
public java.lang.String getLimit()
```
    Returns the "limit" lexeme.
    
    Returns:
    
    The "limit" lexeme.
    
    Since:
    
    0.3.0
  - getVarStatusName
```
public java.lang.String getVarStatusName()
```
    Returns the "varStatus" lexeme.
    
    Returns:
    
    The "varStatus" lexeme.
    
    Since:
    
    0.9.1

Class MetadataParser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VAR_NAME_EXTRA_ROWS

VAR_NAME_LEFT

VAR_NAME_RIGHT

VAR_NAME_COPY_RIGHT

VAR_NAME_FIXED

VAR_NAME_PAST_END_ACTION

VAR_NAME_REPLACE_VALUE

VAR_NAME_GROUP_DIR

VAR_NAME_COLLAPSE

VAR_NAME_ON_LOOP_PROCESSED

VAR_NAME_ON_PROCESSED

VAR_NAME_INDEXVAR

VAR_NAME_LIMIT

VAR_NAME_VAR_STATUS

Constructor Detail

MetadataParser

MetadataParser

Method Detail

setCell

setMetadataText

parse

isRestricted

getAbbreviations

getExtraRows

getColsLeft

getColsRight

isDefiningCols

getCopyingRight

getFixed

getPastEndAction

getReplacementValue

getGroupDir

getCollapsingGroup

getTagLoopListener

getTagListener

getIndexVarName

getLimit

getVarStatusName