Package net.sf.jett.tag

Class TagContext

java.lang.Object

net.sf.jett.tag.TagContext

public class TagContext
extends java.lang.Object

A TagContext object represents the context associated with a Tag.

Author:

Randy Gettman

Constructor Summary

Constructors

Constructor	Description
TagContext()	Construct a TagContext, initializing things to null.

Method Summary

Modifier and Type	Method	Description
org.apache.poi.ss.usermodel.Drawing	createDrawing()	Returns the Sheet's Drawing object, creating it if it doesn't exist.
java.util.Map<java.lang.String,java.lang.Object>	getBeans()	Returns the Map of beans.
Block	getBlock()	Returns the Block that applies to a tag.
java.util.List<java.util.List<org.apache.poi.ss.util.CellRangeAddress>>	getConditionalFormattingRegions()	Returns the List of Lists of CellRangeAddress objects to be manipulated through this TagContext.
Tag	getCurrentTag()	Returns the current Tag for this context.
org.apache.poi.ss.usermodel.Drawing	getDrawing()	Returns the Sheet's Drawing object, if it exists yet.
java.lang.String	getFormulaSuffix()	Returns the formula suffix.
java.util.List<org.apache.poi.ss.util.CellRangeAddress>	getMergedRegions()	Returns the List of CellRangeAddress objects on the current Sheet.
org.apache.poi.ss.usermodel.Drawing	getOrCreateDrawing()	Returns the Sheet's Drawing.
java.util.Map<java.lang.String,org.apache.poi.ss.usermodel.Cell>	getProcessedCellsMap()	Returns the Map of Cells that have already been processed.
org.apache.poi.ss.usermodel.Sheet	getSheet()	Returns the Sheet on which a tag is found.
void	setBeans(java.util.Map<java.lang.String,java.lang.Object> beans)	Sets the Map of beans.
void	setBlock(Block block)	Sets the Block that applies to a tag.
void	setConditionalFormattingRegions(java.util.List<java.util.List<org.apache.poi.ss.util.CellRangeAddress>> conditionalFormattingRegions)	Sets the List of Lists of CellRangeAddress objects to be manipulated through this TagContext.
void	setCurrentTag(Tag tag)	Sets the current Tag for this context.
void	setDrawing(org.apache.poi.ss.usermodel.Drawing drawing)	Sets the Sheet's Drawing object.
void	setFormulaSuffix(java.lang.String formulaSuffix)	Sets the formula suffix.
void	setMergedRegions(java.util.List<org.apache.poi.ss.util.CellRangeAddress> mergedRegions)	Sets the List of CellRangeAddress objects to be manipulated through this TagContext.
void	setProcessedCellsMap(java.util.Map<java.lang.String,org.apache.poi.ss.usermodel.Cell> processedCells)	Sets the Map of Cells that have already been processed.
void	setSheet(org.apache.poi.ss.usermodel.Sheet sheet)	Sets the Sheet on which a tag is found.

Methods inherited from class java.lang.Object

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

Constructor Detail

TagContext

public TagContext()

Construct a TagContext, initializing things to null.

Method Detail

getSheet

public org.apache.poi.ss.usermodel.Sheet getSheet()

Returns the Sheet on which a tag is found.

Returns:

A Sheet.

setSheet

public void setSheet(org.apache.poi.ss.usermodel.Sheet sheet)

Sets the Sheet on which a tag is found.

Parameters:

sheet - A Sheet.

getBlock

public Block getBlock()

Returns the Block that applies to a tag.

Returns:

A Block.

setBlock

public void setBlock(Block block)

Sets the Block that applies to a tag.

Parameters:

block - A Block.

getBeans

public java.util.Map<java.lang.String,java.lang.Object> getBeans()

Returns the Map of beans.

Returns:

A Map of bean names and objects.

setBeans

public void setBeans(java.util.Map<java.lang.String,java.lang.Object> beans)

Sets the Map of beans.

Parameters:

beans - A Map of bean names and objects.

getProcessedCellsMap

public java.util.Map<java.lang.String,org.apache.poi.ss.usermodel.Cell> getProcessedCellsMap()

Returns the Map of Cells that have already been processed.

Returns:

A Map of Cells.

setProcessedCellsMap

public void setProcessedCellsMap(java.util.Map<java.lang.String,org.apache.poi.ss.usermodel.Cell> processedCells)

Sets the Map of Cells that have already been processed.

Parameters:

processedCells - A Map of Cells.

createDrawing

public org.apache.poi.ss.usermodel.Drawing createDrawing()

Returns the Sheet's Drawing object, creating it if it doesn't exist. To avoid clobbering existing drawings, replace a call to this method with a call to getDrawingPatriarch in the POI "ss" package, because that call will NOT corrupt drawings, charts, etc.

Returns:

A Drawing.

Since:

0.2.0

getOrCreateDrawing

public org.apache.poi.ss.usermodel.Drawing getOrCreateDrawing()

Returns the Sheet's Drawing. Creates the Drawing if it doesn't exist yet.

Returns:

A Drawing.

Since:

0.11.0

getDrawing

public org.apache.poi.ss.usermodel.Drawing getDrawing()

Returns the Sheet's Drawing object, if it exists yet.

Returns:

A Drawing, or null if it doesn't exist yet.

Since:

0.2.0

setDrawing

public void setDrawing(org.apache.poi.ss.usermodel.Drawing drawing)

Sets the Sheet's Drawing object. This is usually used to initialize a TagContext from another TagContext, copying the Drawing object.

Parameters:

drawing - A Drawing.

Since:

0.2.0

setMergedRegions

public void setMergedRegions(java.util.List<org.apache.poi.ss.util.CellRangeAddress> mergedRegions)

Sets the List of CellRangeAddress objects to be manipulated through this TagContext. All merged region manipulation for a Sheet goes through this list, instead of the Sheet itself, for performance reasons.

Parameters:

mergedRegions - A List of CellRangeAddresses.

Since:

0.8.0

getMergedRegions

public java.util.List<org.apache.poi.ss.util.CellRangeAddress> getMergedRegions()

Returns the List of CellRangeAddress objects on the current Sheet. For performance reasons, the SheetTransformer reads all merged regions into this list before transformation, all manipulations are done to this list, and after transformation, the list is re-applied to the Sheet.

Returns:

A List of CellRangeAddresses.

Since:

0.8.0

setConditionalFormattingRegions

public void setConditionalFormattingRegions(java.util.List<java.util.List<org.apache.poi.ss.util.CellRangeAddress>> conditionalFormattingRegions)

Sets the List of Lists of CellRangeAddress objects to be manipulated through this TagContext. All conditional formatting range manipulation for a Sheet goes through this list. Each individual list inside the outer list represents the updated cell range addresses for the ConditionalFormatting at the corresponding index.

Parameters:

conditionalFormattingRegions - A List of Lists of CellRangeAddresses.

Since:

0.9.0

getConditionalFormattingRegions

public java.util.List<java.util.List<org.apache.poi.ss.util.CellRangeAddress>> getConditionalFormattingRegions()

Returns the List of Lists of CellRangeAddress objects to be manipulated through this TagContext. All conditional formatting range manipulation for a Sheet goes through this list. Each individual list inside the outer list represents the updated cell range addresses for the ConditionalFormatting at the corresponding index.

Returns:

A List of Lists of CellRangeAddresses.

Since:

0.9.0

getCurrentTag

public Tag getCurrentTag()

Returns the current Tag for this context.

Returns:

The current Tag for this context.

Since:

0.9.0

setCurrentTag

public void setCurrentTag(Tag tag)

Sets the current Tag for this context.

Parameters:

tag - The current Tag for this context.

Since:

0.9.0

getFormulaSuffix

public java.lang.String getFormulaSuffix()

Returns the formula suffix. This is useful for formulas, where keeping track of adjusted cell references in all loop levels is vital.

Returns:

The formula suffix, e.g. "[1,0][2,1]". This would be read as loop 1, iteration 0, subloop 2, iteration 1.

Since:

0.10.0

setFormulaSuffix

public void setFormulaSuffix(java.lang.String formulaSuffix)

Sets the formula suffix. This is useful for formulas, where keeping track of adjusted cell references in all loop levels is vital.

Parameters:

formulaSuffix - The formula suffix, e.g. "[1,0][2,1]". This would be read as loop 1, iteration 0, subloop 2, iteration 1.

Since:

0.10.0