Modifier and Type	Class and Description
private static class	LinkTable.CRNBlock
private static class	LinkTable.ExternalBookBlock

Modifier and Type	Field and Description
private final List<NameRecord>	_definedNames
private LinkTable.ExternalBookBlock[]	_externalBookBlocks
private final ExternSheetRecord	_externSheetRecord
private final int	_recordCount
private final WorkbookRecordList	_workbookRecordList

Access	Constructor and Description
public	LinkTable(List<Record> inputList, int startIndex, WorkbookRecordList workbookRecordList, Map<String, NameCommentRecord> commentRecords)
public	LinkTable(int numberOfSheets, WorkbookRecordList workbookRecordList)

Method Summary

Modifier and Type	Method and Description
public void	addName(NameRecord name)
public NameXPtg	Returns: a NameXPtg describing this name addNameXPtg(String the name to register name) Register an external name in this workbook
public boolean	Returns: true if the oldUrl was found and replaced with newUrl. Otherwise false changeExternalReference(String The old URL to search for and which is to be replaced oldUrl, String The URL replacement newUrl) Changes an external referenced file to another file.
public int	checkExternSheet(int sheetIndex)
public int	checkExternSheet(int firstSheetIndex, int lastSheetIndex)
private int	extendExternalBookBlocks(LinkTable.ExternalBookBlock newBlock)
private int	findFirstRecordLocBySid(short sid) copied from Workbook
private int	findRefIndexFromExtBookIndex(int extBookIndex)
public String[]	getExternalBookAndSheetName(int extRefIndex)
public int	getExternalSheetIndex(String workbookName, String firstSheetName, String lastSheetName)
private int	getExternalWorkbookIndex(String workbookName)
public int	Returns: -1 if the reference is to an external book getFirstInternalSheetIndexForExtIndex(int as from a `Ref3DPtg` or `Area3DPtg` extRefIndex)
public int	Returns: -1 if the reference is to an external book getLastInternalSheetIndexForExtIndex(int as from a `Ref3DPtg` or `Area3DPtg` extRefIndex)
public NameRecord	getNameRecord(int index)
public NameXPtg	getNameXPtg(String name, int The Extern Sheet Index to look for, or -1 if any sheetRefIndex) Finds the external name definition for the given name, optionally restricted by externsheet index, and returns (if found) as a NameXPtg.
public int	getNumNames()
public int	getRecordCount() TODO - would not be required if calling code used RecordStream or similar
private static int	getSheetIndex(String[] sheetNames, String sheetName)
public NameRecord	getSpecificBuiltinRecord(byte a BUILTIN_~ constant from `NameRecord` builtInCode, int 1-based sheet number sheetNumber)
private static boolean	isDuplicatedNames(NameRecord firstName, NameRecord lastName)
private static boolean	isSameSheetNames(NameRecord firstName, NameRecord lastName)
public int	linkExternalWorkbook(String name, Workbook externalWorkbook)
public boolean	nameAlreadyExists(NameRecord name) checks if the given name is already included in the linkTable
private static ExternSheetRecord	readExtSheetRecord(RecordStream rs)
public void	removeBuiltinRecord(byte name, int sheetIndex)
public void	removeName(int namenum)
public void	removeSheet(int sheetIdx)
public int	resolveNameXIx(int refIndex, int definedNameIndex)
public String	resolveNameXText(int refIndex, int definedNameIndex, InternalWorkbook workbook)

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

Field Detail

_definedNames	back to summary
private final List<NameRecord> _definedNames

_externalBookBlocks	back to summary
private LinkTable.ExternalBookBlock[] _externalBookBlocks

_externSheetRecord	back to summary
private final ExternSheetRecord _externSheetRecord

_recordCount	back to summary
private final int _recordCount

_workbookRecordList	back to summary
private final WorkbookRecordList _workbookRecordList

Constructor Detail

LinkTable	back to summary
public LinkTable(List<Record> inputList, int startIndex, WorkbookRecordList workbookRecordList, Map<String, NameCommentRecord> commentRecords)

LinkTable	back to summary
public LinkTable(int numberOfSheets, WorkbookRecordList workbookRecordList)

Method Detail

addName	back to summary
public void addName(NameRecord name)

addNameXPtg	back to summary
public NameXPtg addNameXPtg(String name) Register an external name in this workbook Parameters name:String the name to register Returns:NameXPtg a NameXPtg describing this name

addNameXPtg

back to summary

public NameXPtg addNameXPtg(String name)

Parameters

name:String: the name to register

Returns:NameXPtg

a NameXPtg describing this name

changeExternalReference	back to summary
public boolean changeExternalReference(String oldUrl, String newUrl) Changes an external referenced file to another file. A formular in Excel which refers a cell in another file is saved in two parts: The referenced file is stored in an reference table. the row/cell information is saved separate. This method invokation will only change the reference in the lookup-table itself. Parameters oldUrl:String The old URL to search for and which is to be replaced newUrl:String The URL replacement Returns:boolean true if the oldUrl was found and replaced with newUrl. Otherwise false

changeExternalReference

back to summary

public boolean changeExternalReference(String oldUrl, String newUrl)

Changes an external referenced file to another file. A formular in Excel which refers a cell in another file is saved in two parts: The referenced file is stored in an reference table. the row/cell information is saved separate. This method invokation will only change the reference in the lookup-table itself.

Parameters

oldUrl:String: The old URL to search for and which is to be replaced
newUrl:String: The URL replacement

Returns:boolean

true if the oldUrl was found and replaced with newUrl. Otherwise false

checkExternSheet	back to summary
public int checkExternSheet(int sheetIndex)

checkExternSheet	back to summary
public int checkExternSheet(int firstSheetIndex, int lastSheetIndex)

extendExternalBookBlocks	back to summary
private int extendExternalBookBlocks(LinkTable.ExternalBookBlock newBlock)

findFirstRecordLocBySid	back to summary
private int findFirstRecordLocBySid(short sid) copied from Workbook

findRefIndexFromExtBookIndex	back to summary
private int findRefIndexFromExtBookIndex(int extBookIndex)

getExternalBookAndSheetName	back to summary
public String[] getExternalBookAndSheetName(int extRefIndex)

getExternalSheetIndex	back to summary
public int getExternalSheetIndex(String workbookName, String firstSheetName, String lastSheetName)

getExternalWorkbookIndex	back to summary
private int getExternalWorkbookIndex(String workbookName)

getFirstInternalSheetIndexForExtIndex	back to summary
public int getFirstInternalSheetIndexForExtIndex(int extRefIndex) Parameters extRefIndex:int as from a `Ref3DPtg` or `Area3DPtg` Returns:int -1 if the reference is to an external book

getLastInternalSheetIndexForExtIndex	back to summary
public int getLastInternalSheetIndexForExtIndex(int extRefIndex) Parameters extRefIndex:int as from a `Ref3DPtg` or `Area3DPtg` Returns:int -1 if the reference is to an external book

getNameRecord	back to summary
public NameRecord getNameRecord(int index)

getNameXPtg	back to summary
public NameXPtg getNameXPtg(String name, int sheetRefIndex) Finds the external name definition for the given name, optionally restricted by externsheet index, and returns (if found) as a NameXPtg. Parameters sheetRefIndex:int The Extern Sheet Index to look for, or -1 if any

getNameXPtg

back to summary

public NameXPtg getNameXPtg(String name, int sheetRefIndex)

Finds the external name definition for the given name, optionally restricted by externsheet index, and returns (if found) as a NameXPtg.

Parameters

sheetRefIndex:int: The Extern Sheet Index to look for, or -1 if any

getNumNames	back to summary
public int getNumNames()

getRecordCount	back to summary
public int getRecordCount() TODO - would not be required if calling code used RecordStream or similar

getSheetIndex	back to summary
private static int getSheetIndex(String[] sheetNames, String sheetName)

getSpecificBuiltinRecord	back to summary
public NameRecord getSpecificBuiltinRecord(byte builtInCode, int sheetNumber) Parameters builtInCode:byte a BUILTIN_~ constant from `NameRecord` sheetNumber:int 1-based sheet number

isDuplicatedNames	back to summary
private static boolean isDuplicatedNames(NameRecord firstName, NameRecord lastName)

isSameSheetNames	back to summary
private static boolean isSameSheetNames(NameRecord firstName, NameRecord lastName)

linkExternalWorkbook	back to summary
public int linkExternalWorkbook(String name, Workbook externalWorkbook)

nameAlreadyExists	back to summary
public boolean nameAlreadyExists(NameRecord name) checks if the given name is already included in the linkTable

readExtSheetRecord	back to summary
private static ExternSheetRecord readExtSheetRecord(RecordStream rs)

removeBuiltinRecord	back to summary
public void removeBuiltinRecord(byte name, int sheetIndex)

removeName	back to summary
public void removeName(int namenum)

removeSheet	back to summary
public void removeSheet(int sheetIdx)

resolveNameXIx	back to summary
public int resolveNameXIx(int refIndex, int definedNameIndex)

resolveNameXText	back to summary
public String resolveNameXText(int refIndex, int definedNameIndex, InternalWorkbook workbook)

org.apache.poi.hssf.model back to summary

private final Class LinkTable.CRNBlock

Class Inheritance

extends Object

java.lang.Object
org.apache.poi.hssf.model.LinkTable.CRNBlock

Field Summary

Modifier and Type	Field and Description
private final CRNCountRecord	_countRecord
private final CRNRecord[]	_crns

Constructor Summary

Access	Constructor and Description
public	CRNBlock(RecordStream rs)

Method Summary

Modifier and Type	Method and Description
public CRNRecord[]	getCrns()

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

Field Detail

_countRecord	back to summary
private final CRNCountRecord _countRecord

_crns	back to summary
private final CRNRecord[] _crns

Constructor Detail

CRNBlock	back to summary
public CRNBlock(RecordStream rs)

Method Detail

getCrns	back to summary
public CRNRecord[] getCrns()

org.apache.poi.hssf.model back to summary

private final Class LinkTable.ExternalBookBlock

Class Inheritance

extends Object

java.lang.Object
org.apache.poi.hssf.model.LinkTable.ExternalBookBlock

Field Summary

Modifier and Type	Field and Description
private final LinkTable.CRNBlock[]	_crnBlocks
private final SupBookRecord	_externalBookRecord
private ExternalNameRecord[]	_externalNameRecords

Constructor Summary

Access	Constructor and Description
public	ExternalBookBlock(RecordStream rs)
public	ExternalBookBlock(String url, String[] sheetNames) Create a new block for external references.
public	ExternalBookBlock(int numberOfSheets) Create a new block for internal references.
public	ExternalBookBlock() Create a new block for registering add-in functions

Method Summary

Modifier and Type	Method and Description
public int	addExternalName(ExternalNameRecord rec)
public SupBookRecord	getExternalBookRecord()
public int	Returns: -1 if not found getIndexOfName(String name) Performs case-insensitive search
public int	getNameIx(int definedNameIndex)
public String	getNameText(int definedNameIndex)
public int	getNumberOfNames()

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

Field Detail

_crnBlocks	back to summary
private final LinkTable.CRNBlock[] _crnBlocks

_externalBookRecord	back to summary
private final SupBookRecord _externalBookRecord

_externalNameRecords	back to summary
private ExternalNameRecord[] _externalNameRecords

Constructor Detail

ExternalBookBlock	back to summary
public ExternalBookBlock(RecordStream rs)

ExternalBookBlock	back to summary
public ExternalBookBlock(String url, String[] sheetNames) Create a new block for external references.

ExternalBookBlock back to summary

public ExternalBookBlock(int numberOfSheets)

Create a new block for internal references. It is called when constructing a new LinkTable.

See Also: org.apache.poi.hssf.model.LinkTable#LinkTable(int, WorkbookRecordList)

ExternalBookBlock back to summary

public ExternalBookBlock()

Create a new block for registering add-in functions

See Also: org.apache.poi.hssf.model.LinkTable#addNameXPtg(String)

Method Detail

addExternalName	back to summary
public int addExternalName(ExternalNameRecord rec)

getExternalBookRecord	back to summary
public SupBookRecord getExternalBookRecord()

getIndexOfName

back to summary

public int getIndexOfName(String name)

Performs case-insensitive search

Returns:int: -1 if not found

getNameIx	back to summary
public int getNameIx(int definedNameIndex)

getNameText	back to summary
public String getNameText(int definedNameIndex)

getNumberOfNames	back to summary
public int getNumberOfNames()

pack-priv final Class LinkTable

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class LinkTable.CRNBlock

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class LinkTable.ExternalBookBlock

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail