Package net.sf.jett.transform

Class SheetCloner

java.lang.Object

net.sf.jett.transform.SheetCloner

public class SheetCloner
extends java.lang.Object

A SheetCloner clone sheets and can set them up for implicit collections processing when a collection is detected as part of an expression in a sheet name.

Since:

0.9.1

Author:

Randy Gettman

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	BEGIN_METADATA	Determines the beginning of metadata text inside sheet names only.

Constructor Summary

Constructors

Constructor	Description
SheetCloner(org.apache.poi.ss.usermodel.Workbook workbook)	Constructs an SheetCloner that will work on cloning the given source Sheet, in the given WorkbookContext.

Method Summary

Modifier and Type	Method	Description
void	cloneForSheetSpecificBeans(java.util.List<java.lang.String> templateSheetNames, java.util.List<java.lang.String> newSheetNames)	Clones and moves Sheets around as necessary according to the given template and new sheet names lists.
SheetTransformer.AfterOffSheetProperties	getMissingPropertiesSetter()	Returns an object that can set the missing properties on a Sheet after it has been moved and/or renamed.
java.util.Map<java.lang.String,java.lang.Object>	setupForImplicitCloning(org.apache.poi.ss.usermodel.Sheet sheet, java.util.Map<java.lang.String,java.lang.Object> beans, WorkbookContext context)	Performs all manipulation necessary for implicit cloning, so that the SheetTransformer can transform the resultant sheets as if they were already there.

Methods inherited from class java.lang.Object

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

Field Detail

BEGIN_METADATA

public static final java.lang.String BEGIN_METADATA

Determines the beginning of metadata text inside sheet names only. It's different from the beginning of metadata text inside normal cells (CollectionsTransformer.BEGIN_METADATA) because the normal cells beginning of metadata contains a character that isn't allowed in Excel sheet names.

See Also:

Constant Field Values

Constructor Detail

SheetCloner

public SheetCloner(org.apache.poi.ss.usermodel.Workbook workbook)

Constructs an SheetCloner that will work on cloning the given source Sheet, in the given WorkbookContext.

Parameters:

workbook - The Workbook that contains Sheets that may be cloned/removed.

Method Detail

getMissingPropertiesSetter

public SheetTransformer.AfterOffSheetProperties getMissingPropertiesSetter()

Returns an object that can set the missing properties on a Sheet after it has been moved and/or renamed. This was moved to SheetCloner for version 0.9.1.

Returns:

An object that can set the missing properties on a Sheet.

cloneForSheetSpecificBeans

public void cloneForSheetSpecificBeans(java.util.List<java.lang.String> templateSheetNames,
                                       java.util.List<java.lang.String> newSheetNames)

Clones and moves Sheets around as necessary according to the given template and new sheet names lists. This method initializes the list of Missing Clone Sheet Properties. The logic for this method was extracted out of ExcelTransformer for version 0.9.1.

Parameters:

templateSheetNames - The List of template sheet names.

newSheetNames - The List of new sheet names.

setupForImplicitCloning

public java.util.Map<java.lang.String,java.lang.Object> setupForImplicitCloning(org.apache.poi.ss.usermodel.Sheet sheet,
                                                                                java.util.Map<java.lang.String,java.lang.Object> beans,
                                                                                WorkbookContext context)

Performs all manipulation necessary for implicit cloning, so that the SheetTransformer can transform the resultant sheets as if they were already there.

Parameters:

sheet - The Sheet on which to perform implicit cloning.

beans - The beans map.

context - The WorkbookContext.

Returns:

A beans Map to use for transformation, which may be beans.