io.starter.formats.XLS

Class ReferenceTracker

java.lang.Object

io.starter.formats.XLS.ReferenceTracker

public class ReferenceTracker
extends Object

This class is responsible for registering cell references (Ptgs) and managing reference updates etc. Here's the scenario: as we parse workbooks, WorkBook.addFormula() extracts all PtgRefs and puts them in various ReferenceTracker maps. as cells are inserted/and or changed, referenced cells can be updated after calling 'getAffectedCells'. TODO: retrofit all methods to use sheet_map cache All PtgRefs and Areas

Constructor Summary

Constructors

Constructor and Description
ReferenceTracker()

Method Summary

Modifier and Type	Method and Description
Ptg	addCellRange(Ptg ptgRef) adds a cellrange Ptg (Area, Area3d etc.) to be tracked These records are stored in a row based lookup, this row map is looked up off actual row number, ie row 1 is get(1).
void	addPtgNameReference(PtgName p) Add to the collection of PtgNames for referenceTracker
static void	adjustFormulaRefs(CellHandle newcell, int newrownum, int offset, boolean shiftRow) IF the newly inserted cell is a Formula, we need to update its cell range(s) called by shiftRow
Map	clearAffectedFormulaCells(BiffRec cx) Returns a Collection Map of cells that are affected by formula references to this CellHandle.
Map	clearAffectedFormulaCells(CellHandle cx) Returns a Collection Map of cells that are affected by formula references to this CellHandle.
Map	clearAffectedFormulaCellsOnSheet(CellHandle cx, String sheetname) Returns ALL formulas on the cellhandles sheet that reference this CellHandle.
void	clearCaches() Blow out all the cacheing
void	clearLookupCaches() clear out VLOOKUP and related function caches
void	clearPtgLocationCaches(String targetSheet) Clears out the cached location of ptgrefs in the target sheet.
void	close() clear out object references in prep for closing workbook
CellRange[]	getCellRanges() Returns an Array of the CellRanges existing in this WorkBook specifically the Ranges referenced in Formulas, Charts, and Named Ranges.
List<Ai>	getChartReferences(BiffRec newRec) retrieve all chart-related (==Ai) references to the particular cell
Map	getCriteriaDBs()
Map	getListDBs()
Map	getLookupColCache()
Map	getVlookups()
static void	insertChartSeries(Chart c, String sht, int rownum) insert chart series upon an insert row called by WSH.shiftRow if series are row-based
void	removeCellRange(Ptg cr) removes a cellrange Ptg (Area, Area3d etc.) to be tracked
static boolean	shiftPtg(PtgRef ptgref, String sht, int start, int shiftamount, boolean isExcel2007, boolean shiftRow) given a PtgRef, shifts correctly given start (row or col), shiftamount (+ or - 1) and truth of "shiftRow"
static void	updateAddressPerPolicy(Ptg thisptg, String newaddr) Update the address in a Ptg using the policy defined for the Ptg in an RDF if any.
void	updateInRefTracker(PtgRef pr, XLSRecord parent) updates the tracked ptg by using a new parent record
static void	updateReferences(int start, int shiftamount, Boundsheet thissheet, boolean shiftRow) updateReferences Shifts, Expands or Contracts ALL affected ranges upon a row or col insert or delete.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceTracker

public ReferenceTracker()

Method Detail

getLookupColCache

public Map getLookupColCache()

getVlookups

public Map getVlookups()

Returns:

Returns the vlookups.

getCriteriaDBs

public Map getCriteriaDBs()

Returns:

Returns the criteriaDBs.

getListDBs

public Map getListDBs()

Returns:

Returns the CollectionDBs.

clearCaches

public void clearCaches()

Blow out all the cacheing

clearLookupCaches

public void clearLookupCaches()

clear out VLOOKUP and related function caches

clearAffectedFormulaCellsOnSheet

public Map clearAffectedFormulaCellsOnSheet(CellHandle cx,
                                            String sheetname)

Returns ALL formulas on the cellhandles sheet that reference this CellHandle. Clears the cached value on said cells so a recalc will be forced upon any getVal method Please note that these cells have already been calculated, so in order to get their values without re-calculating them Extentech suggests setting the book level non-calculation flag, ie book.setFormulaCalculationMode(WorkBookHandle.CALCULATE_EXPLICIT); or FormulaHandle.getCachedVal()

Returns:

Collection of of calculated cells

clearAffectedFormulaCells

public Map clearAffectedFormulaCells(CellHandle cx)

Returns a Collection Map of cells that are affected by formula references to this CellHandle. Clears the cached value on said cells and recalcs. Please note that these cells are calculated before return. To get their values without re-calculating them set the book level non-calculation flag, ie book.setFormulaCalculationMode(WorkBookHandle.CALCULATE_EXPLICIT); or FormulaHandle.getCachedVal()

Returns:

Map of calculated cells

clearAffectedFormulaCells

public Map clearAffectedFormulaCells(BiffRec cx)

Returns a Collection Map of cells that are affected by formula references to this CellHandle. Clears the cached value on said cells and recalcs. Please note that these cells are calculated before return. To get their values without re-calculating them set the book level non-calculation flag, ie book.setFormulaCalculationMode(WorkBookHandle.CALCULATE_EXPLICIT); or FormulaHandle.getCachedVal()

Returns:

Map of calculated cells

getChartReferences

public List<Ai> getChartReferences(BiffRec newRec)

retrieve all chart-related (==Ai) references to the particular cell

Parameters:

newRec - cell to lookup references

Returns:

list of Ai records that reference cell

addPtgNameReference

public void addPtgNameReference(PtgName p)

Add to the collection of PtgNames for referenceTracker

addCellRange

public Ptg addCellRange(Ptg ptgRef)

adds a cellrange Ptg (Area, Area3d etc.) to be tracked These records are stored in a row based lookup, this row map is looked up off actual row number, ie row 1 is get(1).

Parameters:

cr -

Returns:

clearPtgLocationCaches

public void clearPtgLocationCaches(String targetSheet)

Clears out the cached location of ptgrefs in the target sheet. This is required for copied worksheets with ptgrefs contained internally

Parameters:

targetSheet -

removeCellRange

public void removeCellRange(Ptg cr)

removes a cellrange Ptg (Area, Area3d etc.) to be tracked

Parameters:

cr -

updateInRefTracker

public void updateInRefTracker(PtgRef pr,
                               XLSRecord parent)

updates the tracked ptg by using a new parent record

Parameters:

pr - original ptg contained in tracker

parent - new parent record of ptg

getCellRanges

public CellRange[] getCellRanges()

Returns an Array of the CellRanges existing in this WorkBook specifically the Ranges referenced in Formulas, Charts, and Named Ranges. This is necessary to allow for automatic updating of references when adding/removing/moving Cells within these ranges, as well as shifting references to Cells in Formulas when Formula records are moved.

Returns:

all existing Cell Range references used in Formulas, Charts, and Names

updateReferences

public static void updateReferences(int start,
                                    int shiftamount,
                                    Boundsheet thissheet,
                                    boolean shiftRow)

updateReferences Shifts, Expands or Contracts ALL affected ranges upon a row or col insert or delete. This will eventually eliminate the need for subequent shifting done in moveFormulaCellReferences] this will move the entire range down if range first row > startrow it will expand the range if range first row <= startrow and range second row <= startrow

Parameters:

start - 0-based start row

shift - shift amount can be + or -

thissheet -

shiftRow - true if shifting rows (false for columns)

shiftPtg

public static boolean shiftPtg(PtgRef ptgref,
                               String sht,
                               int start,
                               int shiftamount,
                               boolean isExcel2007,
                               boolean shiftRow)

given a PtgRef, shifts correctly given start (row or col), shiftamount (+ or - 1) and truth of "shiftRow"

Parameters:

ptgref - = the ptgref to move

sht - = the sheet in which the ptgref resides

start - = Start row for shifting - This is a 0 based value

shiftamount - = amount to shift the ptgref

isExcel2007 - true if use Excel-2007 maximums

shiftRow - = ?

Returns:

true if updated PtgRef location

insertChartSeries

public static void insertChartSeries(Chart c,
                                     String sht,
                                     int rownum)

insert chart series upon an insert row called by WSH.shiftRow if series are row-based

updateAddressPerPolicy

public static void updateAddressPerPolicy(Ptg thisptg,
                                          String newaddr)

Update the address in a Ptg using the policy defined for the Ptg in an RDF if any. called by changeFormulaLocation, addCellToRange

Parameters:

thisptg -

newaddr -

adjustFormulaRefs

public static void adjustFormulaRefs(CellHandle newcell,
                                     int newrownum,
                                     int offset,
                                     boolean shiftRow)
                              throws Exception

IF the newly inserted cell is a Formula, we need to update its cell range(s) called by shiftRow

Parameters:

copycell -

oldaddr -

newaddr -

rownum -

shiftRow - true if shifting rows and not columns

Throws:

Exception

See Also:

WorkSheetHandle.shiftRow

close

public void close()

clear out object references in prep for closing workbook