Modifier and Type	Class and Description
private static class	SharedValueManager.SharedFormulaGroup

Modifier and Type	Field and Description
private final List<ArrayRecord>	_arrayRecords
private final Map<SharedFormulaRecord, SharedValueManager.SharedFormulaGroup>	_groupsBySharedFormulaRecord
private Map<Integer, SharedValueManager.SharedFormulaGroup>	_groupsCache cached for optimization purposes
private final TableRecord[]	_tableRecords

Access	Constructor and Description
private	SharedValueManager(SharedFormulaRecord[] sharedFormulaRecords, CellReference[] firstCells, ArrayRecord[] arrayRecords, TableRecord[] tableRecords)

Method Summary

Modifier and Type	Method and Description
public void	addArrayRecord(ArrayRecord ar) Add specified Array Record.
public static SharedValueManager	create(SharedFormulaRecord[] sharedFormulaRecords, CellReference[] firstCells, ArrayRecord[] arrayRecords, TableRecord[] tableRecords)
public static SharedValueManager	Returns: a new empty SharedValueManager. createEmpty()
private SharedValueManager.SharedFormulaGroup	findFormulaGroupForCell(final CellReference cellRef)
public ArrayRecord	Returns: the shared ArrayRecord identified by (firstRow, firstColumn). never `null`. getArrayRecord(int firstRow, int firstColumn)
private Integer	getKeyForCache(final CellReference cellRef)
public SharedValueRecordBase	Returns: the SHRFMLA, TABLE or ARRAY record for the formula cell, if it is the first cell of a table or array region. `null` if the formula cell is not shared/array/table, or if the specified formula is not the first in the group. getRecordForFirstCell(FormulaRecordAggregate agg) Gets the `SharedValueRecordBase` record if it should be encoded immediately after the formula record contained in the specified `FormulaRecordAggregate` agg.
public SharedFormulaRecord	Returns: never `null` linkSharedFormulaRecord(CellReference as extracted from the `ExpPtg` from the cell's formula. firstCell, FormulaRecordAggregate agg)
public CellRangeAddress8Bit	Returns: the range of the array formula which was just removed. Never `null`. removeArrayFormula(int rowIndex, int columnIndex) Removes the `ArrayRecord` for the cell group containing the specified cell.
private static <Z> List<Z>	Returns: a modifiable list, independent of the supplied array toList(Z[] zz)
public void	unlink(SharedFormulaRecord sharedFormulaRecord) Converts all `FormulaRecord`s handled by `sharedFormulaRecord` to plain unshared formulas

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_arrayRecords	back to summary
private final List<ArrayRecord> _arrayRecords

_groupsBySharedFormulaRecord	back to summary
private final Map<SharedFormulaRecord, SharedValueManager.SharedFormulaGroup> _groupsBySharedFormulaRecord

_groupsCache	back to summary
private Map<Integer, SharedValueManager.SharedFormulaGroup> _groupsCache cached for optimization purposes

_tableRecords	back to summary
private final TableRecord[] _tableRecords

Constructor Detail

SharedValueManager	back to summary
private SharedValueManager(SharedFormulaRecord[] sharedFormulaRecords, CellReference[] firstCells, ArrayRecord[] arrayRecords, TableRecord[] tableRecords)

Method Detail

addArrayRecord	back to summary
public void addArrayRecord(ArrayRecord ar) Add specified Array Record.

create	back to summary
public static SharedValueManager create(SharedFormulaRecord[] sharedFormulaRecords, CellReference[] firstCells, ArrayRecord[] arrayRecords, TableRecord[] tableRecords)

createEmpty	back to summary
public static SharedValueManager createEmpty() Returns:SharedValueManager a new empty SharedValueManager.

findFormulaGroupForCell	back to summary
private SharedValueManager.SharedFormulaGroup findFormulaGroupForCell(final CellReference cellRef)

getArrayRecord	back to summary
public ArrayRecord getArrayRecord(int firstRow, int firstColumn) Returns:ArrayRecord the shared ArrayRecord identified by (firstRow, firstColumn). never `null`.

getKeyForCache	back to summary
private Integer getKeyForCache(final CellReference cellRef)

getRecordForFirstCell back to summary

getRecordForFirstCell	back to summary
public SharedValueRecordBase getRecordForFirstCell(FormulaRecordAggregate agg) Gets the `SharedValueRecordBase` record if it should be encoded immediately after the formula record contained in the specified `FormulaRecordAggregate` agg. Note - the shared value record always appears after the first formula record in the group. For arrays and tables the first formula is always the in the top left cell. However, since shared formula groups can be sparse and/or overlap, the first formula may not actually be in the top left cell. Returns:SharedValueRecordBase the SHRFMLA, TABLE or ARRAY record for the formula cell, if it is the first cell of a table or array region. `null` if the formula cell is not shared/array/table, or if the specified formula is not the first in the group.

public SharedValueRecordBase getRecordForFirstCell(FormulaRecordAggregate agg)

Gets the SharedValueRecordBase record if it should be encoded immediately after the formula record contained in the specified FormulaRecordAggregate agg. Note - the shared value record always appears after the first formula record in the group. For arrays and tables the first formula is always the in the top left cell. However, since shared formula groups can be sparse and/or overlap, the first formula may not actually be in the top left cell.

Returns:SharedValueRecordBase: the SHRFMLA, TABLE or ARRAY record for the formula cell, if it is the first cell of a table or array region. null if the formula cell is not shared/array/table, or if the specified formula is not the first in the group.

linkSharedFormulaRecord	back to summary
public SharedFormulaRecord linkSharedFormulaRecord(CellReference firstCell, FormulaRecordAggregate agg) Parameters firstCell:CellReference as extracted from the `ExpPtg` from the cell's formula. Returns:SharedFormulaRecord never `null`

removeArrayFormula back to summary

removeArrayFormula	back to summary
public CellRangeAddress8Bit removeArrayFormula(int rowIndex, int columnIndex) Removes the `ArrayRecord` for the cell group containing the specified cell. The caller should clear (set blank) all cells in the returned range. Returns:CellRangeAddress8Bit the range of the array formula which was just removed. Never `null`.

public CellRangeAddress8Bit removeArrayFormula(int rowIndex, int columnIndex)

Removes the ArrayRecord for the cell group containing the specified cell. The caller should clear (set blank) all cells in the returned range.

Returns:CellRangeAddress8Bit: the range of the array formula which was just removed. Never null.

toList	back to summary
private static <Z> List<Z> toList(Z[] zz) Returns:List<Z> a modifiable list, independent of the supplied array

unlink	back to summary
public void unlink(SharedFormulaRecord sharedFormulaRecord) Converts all `FormulaRecord`s handled by `sharedFormulaRecord` to plain unshared formulas

org.apache.poi.hssf.record.aggregates back to summary

private final Class SharedValueManager.SharedFormulaGroup

Class Inheritance

extends Object

java.lang.Object
org.apache.poi.hssf.record.aggregates.SharedValueManager.SharedFormulaGroup

Field Summary

Modifier and Type	Field and Description
private final CellReference	_firstCell Coordinates of the first cell having a formula that uses this shared formula.
private final FormulaRecordAggregate[]	_frAggs
private int	_numberOfFormulas
private final SharedFormulaRecord	_sfr

Constructor Summary

Access	Constructor and Description
public	SharedFormulaGroup(SharedFormulaRecord sfr, CellReference firstCell)

Method Summary

Modifier and Type	Method and Description
public void	add(FormulaRecordAggregate agg)
public SharedFormulaRecord	getSFR()
public final String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	unlinkSharedFormulas()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

_firstCell	back to summary
private final CellReference _firstCell Coordinates of the first cell having a formula that uses this shared formula. This is often but not always the top left cell in the range covered by `_sfr`

_frAggs	back to summary
private final FormulaRecordAggregate[] _frAggs

_numberOfFormulas	back to summary
private int _numberOfFormulas

_sfr	back to summary
private final SharedFormulaRecord _sfr

Constructor Detail

SharedFormulaGroup	back to summary
public SharedFormulaGroup(SharedFormulaRecord sfr, CellReference firstCell)

Method Detail

add	back to summary
public void add(FormulaRecordAggregate agg)

getSFR	back to summary
public SharedFormulaRecord getSFR()

toString back to summary

toString	back to summary
public final String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object

public final String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object

unlinkSharedFormulas	back to summary
public void unlinkSharedFormulas()

public final Class SharedValueManager

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class SharedValueManager.SharedFormulaGroup

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail