WorkbookContext (Jett 0.11.0 API)

java.lang.Object
- net.sf.jett.model.WorkbookContext

```
public class WorkbookContext
extends java.lang.Object
```
A WorkbookContext object holds data relevant to the context of a Workbook.

Author:

Randy Gettman

Constructor Summary

Constructors
Constructor Description

WorkbookContext()
Initializes things to null/0.

Constructors
Constructor	Description
`WorkbookContext()`	Initializes things to null/0.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.List<java.util.Map<java.lang.String,java.lang.Object>>`	`getBeansMaps()`	Returns a `List` of beans maps.
`java.util.List<CellListener>`	`getCellListeners()`	Returns the `CellListeners`.
`java.util.Map<java.lang.String,java.util.List<CellRef>>`	`getCellRefMap()`	Returns the cell reference map, a `Map` of cell key strings to `Lists` of `CellRefs`.
`CellStyleCache`	`getCellStyleCache()`	Returns the `CellStyleCache`.
`ExpressionFactory`	`getExpressionFactory()`	Returns the `ExpressionFactory`.
`java.util.List<java.lang.String>`	`getFixedSizedCollectionNames()`	Returns the `List` of "fixed size" collection names.
`FontCache`	`getFontCache()`	Returns the `FontCache`.
`java.util.Map<java.lang.String,Formula>`	`getFormulaMap()`	Returns the formula map, a `Map` of formula keys to `Formulas`, with the keys of the format "sheetName!formula".
`java.util.List<java.lang.String>`	`getNoImplicitProcessingCollectionNames()`	Returns the `List` of collection names on which NOT to perform implicit collections processing.
`TagLibraryRegistry`	`getRegistry()`	Returns the `TagLibraryRegistry`.
`int`	`getSequenceNbr()`	Returns the current sequence number.
`java.util.List<SheetListener>`	`getSheetListeners()`	Returns the `SheetListeners`.
`java.util.List<java.lang.String>`	`getSheetNames()`	Returns a `List` of sheet names.
`java.util.Map<java.lang.String,Style>`	`getStyleMap()`	Returns the `Map` of style names to `Styles`.
`java.util.Map<java.lang.String,java.lang.String>`	`getTagLocationsMap()`	Returns the tag locations map, a `Map` of current tag location cell references to original tag location cell references, with the cell references being in the format "Sheet!B1".
`java.util.List<java.lang.String>`	`getTemplateSheetNames()`	Returns a `List` of template sheet names.
`void`	`incrSequenceNbr()`	Increments the current sequence number.
`void`	`setBeansMaps(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> beansMaps)`	Stores a copy of the given `List` of beans maps.
`void`	`setCellListeners(java.util.List<CellListener> cellListeners)`	Sets the `CellListeners`.
`void`	`setCellRefMap(java.util.Map<java.lang.String,java.util.List<CellRef>> cellRefMap)`	Sets the cell reference map, a `Map` of cell key strings to `Lists` of `CellRefs`.
`void`	`setCellStyleCache(CellStyleCache cache)`	Sets the `CellStyleCache`.
`void`	`setExpressionFactory(ExpressionFactory factory)`	Sets the `ExpressionFactory`.
`void`	`setFixedSizeCollectionNames(java.util.List<java.lang.String> collNames)`	These named `Collections` have a known size and do not need to have other `Cells` shifted out of the way for its contents; space is already allocated.
`void`	`setFontCache(FontCache cache)`	Sets the `FontCache`.
`void`	`setFormulaMap(java.util.Map<java.lang.String,Formula> formulaMap)`	Sets the formula map, a `Map` of formula keys to `Formulas`, with the keys of the format "sheetName!formula".
`void`	`setNoImplicitCollectionProcessingNames(java.util.List<java.lang.String> collNames)`	Turn off implicit collections processing for the given `Collections` specified by the given collection names.
`void`	`setRegistry(TagLibraryRegistry registry)`	Sets the `TagLibraryRegistry`.
`void`	`setSheetListeners(java.util.List<SheetListener> sheetListeners)`	Sets the `SheetListeners`.
`void`	`setSheetNames(java.util.List<java.lang.String> sheetNames)`	Stores a copy of the given `List` of sheet names.
`void`	`setStyleMap(java.util.Map<java.lang.String,Style> styleMap)`	Sets `Map` of style names to `Styles`.
`void`	`setTagLocationsMap(java.util.Map<java.lang.String,java.lang.String> tagLocationsMap)`	Sets the tag locations map, a `Map` of current tag location cell references to original tag location cell references, with the cell references being in the format "Sheet!B1".
`void`	`setTemplateSheetNames(java.util.List<java.lang.String> templateSheetNames)`	Stores a copy of the given `List` of template sheet names.

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

- Constructor Detail
  - WorkbookContext
```
public WorkbookContext()
```
    Initializes things to null/0.
- Method Detail
  - getRegistry
```
public TagLibraryRegistry getRegistry()
```
    Returns the TagLibraryRegistry.
    
    Returns:
    
    The TagLibraryRegistry.
  - setRegistry
```
public void setRegistry(TagLibraryRegistry registry)
```
    Sets the TagLibraryRegistry.
    
    Parameters:
    
    registry - The TagLibraryRegistry.
  - getCellListeners
```
public java.util.List<CellListener> getCellListeners()
```
    Returns the CellListeners.
    
    Returns:
    
    The CellListeners.
  - getSheetListeners
```
public java.util.List<SheetListener> getSheetListeners()
```
    Returns the SheetListeners.
    
    Returns:
    
    The SheetListeners.
    
    Since:
    
    0.8.0
  - setSheetListeners
```
public void setSheetListeners(java.util.List<SheetListener> sheetListeners)
```
    Sets the SheetListeners.
    
    Parameters:
    
    sheetListeners - The SheetListeners.
    
    Since:
    
    0.8.0
  - setCellListeners
```
public void setCellListeners(java.util.List<CellListener> cellListeners)
```
    Sets the CellListeners.
    
    Parameters:
    
    cellListeners - The CellListeners.
  - setFixedSizeCollectionNames
```
public void setFixedSizeCollectionNames(java.util.List<java.lang.String> collNames)
```
    These named Collections have a known size and do not need to have other Cells shifted out of the way for its contents; space is already allocated.
    
    Parameters:
    
    collNames - A List of Collection names that don't need other Cells shifted out of the way for its contents.
  - getFixedSizedCollectionNames
```
public java.util.List<java.lang.String> getFixedSizedCollectionNames()
```
    Returns the List of "fixed size" collection names.
    
    Returns:
    
    The List of "fixed size" collection names.
  - setNoImplicitCollectionProcessingNames
```
public void setNoImplicitCollectionProcessingNames(java.util.List<java.lang.String> collNames)
```
    Turn off implicit collections processing for the given Collections specified by the given collection names.
    
    Parameters:
    
    collNames - The names of the Collections on which NOT to perform implicit collections processing.
  - getNoImplicitProcessingCollectionNames
```
public java.util.List<java.lang.String> getNoImplicitProcessingCollectionNames()
```
    Returns the List of collection names on which NOT to perform implicit collections processing.
    
    Returns:
    
    The List of collection names on which NOT to perform implicit collections processing.
  - getFormulaMap
```
public java.util.Map<java.lang.String,Formula> getFormulaMap()
```
    Returns the formula map, a Map of formula keys to Formulas, with the keys of the format "sheetName!formula".
    
    Returns:
    
    A Map of formula keys to Formulas.
  - setFormulaMap
```
public void setFormulaMap(java.util.Map<java.lang.String,Formula> formulaMap)
```
    Sets the formula map, a Map of formula keys to Formulas, with the keys of the format "sheetName!formula".
    
    Parameters:
    
    formulaMap - A Map of formula keys to Formulas.
  - getTagLocationsMap
```
public java.util.Map<java.lang.String,java.lang.String> getTagLocationsMap()
```
    Returns the tag locations map, a Map of current tag location cell references to original tag location cell references, with the cell references being in the format "Sheet!B1". This is currently used only to identify original tag locations for exception messages.
    
    Returns:
    
    A Map of current tag location cell references to original tag location cell references.
    
    Since:
    
    0.9.0
  - setTagLocationsMap
```
public void setTagLocationsMap(java.util.Map<java.lang.String,java.lang.String> tagLocationsMap)
```
    Sets the tag locations map, a Map of current tag location cell references to original tag location cell references, with the cell references being in the format "Sheet!B1". This is currently used only to identify original tag locations for exception messages.
    
    Parameters:
    
    tagLocationsMap - A Map of current tag location cell references to original tag location cell references.
    
    Since:
    
    0.9.0
  - getCellRefMap
```
public java.util.Map<java.lang.String,java.util.List<CellRef>> getCellRefMap()
```
    Returns the cell reference map, a Map of cell key strings to Lists of CellRefs. The cell key strings are original cell references, and the Lists contain translated CellRefs, e.g. "Sheet1!C2" => [C2, C3, C4]
    
    Returns:
    
    A Map of cell key strings to Lists of CellRefs.
  - setCellRefMap
```
public void setCellRefMap(java.util.Map<java.lang.String,java.util.List<CellRef>> cellRefMap)
```
    Sets the cell reference map, a Map of cell key strings to Lists of CellRefs. The cell key strings are original cell references, and the Lists contain translated CellRefs, e.g. "Sheet1!C2" => [C2, C3, C4]
    
    Parameters:
    
    cellRefMap - A Map of cell key strings to Lists of CellRefs.
  - getSequenceNbr
```
public int getSequenceNbr()
```
    Returns the current sequence number.
    
    Returns:
    
    The current sequence number.
  - incrSequenceNbr
```
public void incrSequenceNbr()
```
    Increments the current sequence number.
  - getCellStyleCache
```
public CellStyleCache getCellStyleCache()
```
    Returns the CellStyleCache.
    
    Returns:
    
    The CellStyleCache.
    
    Since:
    
    0.5.0
  - setCellStyleCache
```
public void setCellStyleCache(CellStyleCache cache)
```
    Sets the CellStyleCache.
    
    Parameters:
    
    cache - A CellStyleCache.
    
    Since:
    
    0.5.0
  - getFontCache
```
public FontCache getFontCache()
```
    Returns the FontCache.
    
    Returns:
    
    The FontCache.
    
    Since:
    
    0.5.0
  - setFontCache
```
public void setFontCache(FontCache cache)
```
    Sets the FontCache.
    
    Parameters:
    
    cache - The FontCache.
    
    Since:
    
    0.5.0
  - getStyleMap
```
public java.util.Map<java.lang.String,Style> getStyleMap()
```
    Returns the Map of style names to Styles.
    
    Returns:
    
    The Map of style names to Styles.
    
    Since:
    
    0.5.0
  - setStyleMap
```
public void setStyleMap(java.util.Map<java.lang.String,Style> styleMap)
```
    Sets Map of style names to Styles.
    
    Parameters:
    
    styleMap - The Map of style names to Styles.
    
    Since:
    
    0.5.0
  - getTemplateSheetNames
```
public java.util.List<java.lang.String> getTemplateSheetNames()
```
    Returns a List of template sheet names.
    
    Returns:
    
    A List of template sheet names.
    
    Since:
    
    0.8.0
  - setTemplateSheetNames
```
public void setTemplateSheetNames(java.util.List<java.lang.String> templateSheetNames)
```
    Stores a copy of the given List of template sheet names.
    
    Parameters:
    
    templateSheetNames - A List of template sheet names.
    
    Since:
    
    0.8.0
  - getSheetNames
```
public java.util.List<java.lang.String> getSheetNames()
```
    Returns a List of sheet names.
    
    Returns:
    
    A List of sheet names.
    
    Since:
    
    0.8.0
  - setSheetNames
```
public void setSheetNames(java.util.List<java.lang.String> sheetNames)
```
    Stores a copy of the given List of sheet names.
    
    Parameters:
    
    sheetNames - A List of sheet names.
    
    Since:
    
    0.8.0
  - getExpressionFactory
```
public ExpressionFactory getExpressionFactory()
```
    Returns the ExpressionFactory.
    
    Returns:
    
    The ExpressionFactory.
    
    Since:
    
    0.9.0
  - setExpressionFactory
```
public void setExpressionFactory(ExpressionFactory factory)
```
    Sets the ExpressionFactory.
    
    Parameters:
    
    factory - The ExpressionFactory.
    
    Since:
    
    0.9.0
  - getBeansMaps
```
public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getBeansMaps()
```
    Returns a List of beans maps.
    
    Returns:
    
    A List of beans maps.
    
    Since:
    
    0.9.1
  - setBeansMaps
```
public void setBeansMaps(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> beansMaps)
```
    Stores a copy of the given List of beans maps.
    
    Parameters:
    
    beansMaps - A List of beans maps.
    
    Since:
    
    0.9.1

Class WorkbookContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkbookContext

Method Detail

getRegistry

setRegistry

getCellListeners

getSheetListeners

setSheetListeners

setCellListeners

setFixedSizeCollectionNames

getFixedSizedCollectionNames

setNoImplicitCollectionProcessingNames

getNoImplicitProcessingCollectionNames

getFormulaMap

setFormulaMap

getTagLocationsMap

setTagLocationsMap

getCellRefMap

setCellRefMap

getSequenceNbr

incrSequenceNbr

getCellStyleCache

setCellStyleCache

getFontCache

setFontCache

getStyleMap

setStyleMap

getTemplateSheetNames

setTemplateSheetNames

getSheetNames

setSheetNames

getExpressionFactory

setExpressionFactory

getBeansMaps

setBeansMaps