Modifier and Type	Class and Description
private static class	ExternSheetRecord.RefSubRecord

Modifier and Type	Field and Description
private final List<ExternSheetRecord.RefSubRecord>	_list
public static final short	sid

Access	Constructor and Description
public	ExternSheetRecord()
public	ExternSheetRecord(ExternSheetRecord other)
public	ExternSheetRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
public int	Returns: index of newly added ref addRef(int the external book block index extBookIndex, int the scope, must be -2 for add-in references firstSheetIndex, int the scope, must be -2 for add-in references lastSheetIndex) Add a zero-based reference to a `org.apache.poi.hssf.record.SupBookRecord`.
public void	addREFRecord(ExternSheetRecord.RefSubRecord REF struct rec) adds REF struct (ExternSheetSubRecord)
public static ExternSheetRecord	combine(ExternSheetRecord[] esrs)
public ExternSheetRecord	copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy.
public int	Returns: -1 if not found findRefIndexFromExtBookIndex(int external sheet reference index extBookIndex)
protected int	getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.
public int	Returns: the index of the SupBookRecord for this index getExtbookIndexFromRefIndex(int specifies the n-th refIndex refIndex)
public int	Returns: the first sheet that the reference applies to, or -1 if the referenced sheet can't be found, or -2 if the reference is workbook scoped getFirstSheetIndexFromRefIndex(int external sheet reference index extRefIndex) Returns the first sheet that the reference applies to, or -1 if the referenced sheet can't be found, or -2 if the reference is workbook scoped.
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public HSSFRecordTypes	getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.
public int	Returns: the last sheet that the reference applies to, or -1 if the referenced sheet can't be found, or -2 if the reference is workbook scoped. getLastSheetIndexFromRefIndex(int external sheet reference index extRefIndex) Returns the last sheet that the reference applies to, or -1 if the referenced sheet can't be found, or -2 if the reference is workbook scoped.
public int	Returns: number of REF records getNumOfREFRecords() returns the number of REF Records, which is in model
public int	Returns: number of REF structures getNumOfRefs()
private ExternSheetRecord.RefSubRecord	getRef(int i)
public int	getRefIxForSheet(int externalBookIndex, int firstSheetIndex, int lastSheetIndex)
public short	getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record.
public void	removeSheet(int sheetIdx)
public void	serialize(LittleEndianOutput the output object out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Write the data content of this BIFF record.

Inherited from org.apache.poi.hssf.record.StandardRecord:: getRecordSize serialize

Field Detail

_list	back to summary
private final List<ExternSheetRecord.RefSubRecord> _list

sid	back to summary
public static final short sid

Constructor Detail

ExternSheetRecord	back to summary
public ExternSheetRecord()

ExternSheetRecord	back to summary
public ExternSheetRecord(ExternSheetRecord other)

ExternSheetRecord	back to summary
public ExternSheetRecord(RecordInputStream in)

Method Detail

addRef back to summary

addRef	back to summary
public int addRef(int extBookIndex, int firstSheetIndex, int lastSheetIndex) Add a zero-based reference to a `org.apache.poi.hssf.record.SupBookRecord`. If the type of the SupBook record is same-sheet referencing, Add-In referencing, DDE data source referencing, or OLE data source referencing, then no scope is specified and this value MUST be -2. Otherwise, the scope must be set as follows: `-2` Workbook-level reference that applies to the entire workbook. `-1` Sheet-level reference. `>=0` Sheet-level reference. This specifies the first sheet in the reference. If the SupBook type is unused or external workbook referencing, then this value specifies the zero-based index of an external sheet name, see `org.apache.poi.hssf.record.SupBookRecord#getSheetNames()`. This referenced string specifies the name of the first sheet within the external workbook that is in scope. This sheet MUST be a worksheet or macro sheet. If the supporting link type is self-referencing, then this value specifies the zero-based index of a `org.apache.poi.hssf.record.BoundSheetRecord` record in the workbook stream that specifies the first sheet within the scope of this reference. This sheet MUST be a worksheet or a macro sheet. Parameters extBookIndex:int the external book block index firstSheetIndex:int the scope, must be -2 for add-in references lastSheetIndex:int the scope, must be -2 for add-in references Returns:int index of newly added ref

public int addRef(int extBookIndex, int firstSheetIndex, int lastSheetIndex)

Add a zero-based reference to a org.apache.poi.hssf.record.SupBookRecord.

If the type of the SupBook record is same-sheet referencing, Add-In referencing, DDE data source referencing, or OLE data source referencing, then no scope is specified and this value MUST be -2. Otherwise, the scope must be set as follows:

-2 Workbook-level reference that applies to the entire workbook.
-1 Sheet-level reference.
>=0 Sheet-level reference. This specifies the first sheet in the reference.
If the SupBook type is unused or external workbook referencing, then this value specifies the zero-based index of an external sheet name, see org.apache.poi.hssf.record.SupBookRecord#getSheetNames(). This referenced string specifies the name of the first sheet within the external workbook that is in scope. This sheet MUST be a worksheet or macro sheet.

If the supporting link type is self-referencing, then this value specifies the zero-based index of a org.apache.poi.hssf.record.BoundSheetRecord record in the workbook stream that specifies the first sheet within the scope of this reference. This sheet MUST be a worksheet or a macro sheet.

Parameters

extBookIndex:int: the external book block index
firstSheetIndex:int: the scope, must be -2 for add-in references
lastSheetIndex:int: the scope, must be -2 for add-in references

Returns:int

index of newly added ref

addREFRecord	back to summary
public void addREFRecord(ExternSheetRecord.RefSubRecord rec) adds REF struct (ExternSheetSubRecord) Parameters rec:ExternSheetRecord.RefSubRecord REF struct

addREFRecord

back to summary

public void addREFRecord(ExternSheetRecord.RefSubRecord rec)

adds REF struct (ExternSheetSubRecord)

Parameters

rec:ExternSheetRecord.RefSubRecord: REF struct

combine	back to summary
public static ExternSheetRecord combine(ExternSheetRecord[] esrs)

copy	back to summary
public ExternSheetRecord copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy. Returns:ExternSheetRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public ExternSheetRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:ExternSheetRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations

@Override

findRefIndexFromExtBookIndex	back to summary
public int findRefIndexFromExtBookIndex(int extBookIndex) Parameters extBookIndex:int external sheet reference index Returns:int -1 if not found

getDataSize	back to summary
protected int getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize. Annotations @Override

getDataSize

back to summary

protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

Annotations

@Override

getExtbookIndexFromRefIndex	back to summary
public int getExtbookIndexFromRefIndex(int refIndex) Parameters refIndex:int specifies the n-th refIndex Returns:int the index of the SupBookRecord for this index

getFirstSheetIndexFromRefIndex	back to summary
public int getFirstSheetIndexFromRefIndex(int extRefIndex) Returns the first sheet that the reference applies to, or -1 if the referenced sheet can't be found, or -2 if the reference is workbook scoped. Parameters extRefIndex:int external sheet reference index Returns:int the first sheet that the reference applies to, or -1 if the referenced sheet can't be found, or -2 if the reference is workbook scoped

getFirstSheetIndexFromRefIndex

back to summary

public int getFirstSheetIndexFromRefIndex(int extRefIndex)

Returns the first sheet that the reference applies to, or -1 if the referenced sheet can't be found, or -2 if the reference is workbook scoped.

Parameters

extRefIndex:int: external sheet reference index

Returns:int

the first sheet that the reference applies to, or -1 if the referenced sheet can't be found, or -2 if the reference is workbook scoped

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getGenericRecordType	back to summary
public HSSFRecordTypes getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType. Annotations @Override

getGenericRecordType

back to summary

public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations

@Override

getLastSheetIndexFromRefIndex	back to summary
public int getLastSheetIndexFromRefIndex(int extRefIndex) Returns the last sheet that the reference applies to, or -1 if the referenced sheet can't be found, or -2 if the reference is workbook scoped. For a single sheet reference, the first and last should be the same. Parameters extRefIndex:int external sheet reference index Returns:int the last sheet that the reference applies to, or -1 if the referenced sheet can't be found, or -2 if the reference is workbook scoped.

getLastSheetIndexFromRefIndex

back to summary

public int getLastSheetIndexFromRefIndex(int extRefIndex)

Returns the last sheet that the reference applies to, or -1 if the referenced sheet can't be found, or -2 if the reference is workbook scoped. For a single sheet reference, the first and last should be the same.

Parameters

extRefIndex:int: external sheet reference index

Returns:int

the last sheet that the reference applies to, or -1 if the referenced sheet can't be found, or -2 if the reference is workbook scoped.

getNumOfREFRecords	back to summary
public int getNumOfREFRecords() returns the number of REF Records, which is in model Returns:int number of REF records

getNumOfREFRecords

back to summary

public int getNumOfREFRecords()

returns the number of REF Records, which is in model

Returns:int: number of REF records

getNumOfRefs	back to summary
public int getNumOfRefs() Returns:int number of REF structures

getRef	back to summary
private ExternSheetRecord.RefSubRecord getRef(int i)

getRefIxForSheet	back to summary
public int getRefIxForSheet(int externalBookIndex, int firstSheetIndex, int lastSheetIndex)

getSid	back to summary
public short getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record. Returns:short Doc from org.apache.poi.hssf.record.Record.getSid. he id for this record Annotations @Override

getSid

back to summary

public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short

Doc from org.apache.poi.hssf.record.Record.getSid.

he id for this record

Annotations

@Override

removeSheet	back to summary
public void removeSheet(int sheetIdx)

serialize back to summary

serialize	back to summary
public void serialize(LittleEndianOutput out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Doc from org.apache.poi.hssf.record.StandardRecord.serialize. Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass. The number of bytes written must equal the record size reported by `org.apache.poi.hssf.record.Record#getRecordSize()`} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass). Parameters out:LittleEndianOutput the output object Annotations @Override

public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

The number of bytes written must equal the record size reported by org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters

out:LittleEndianOutput: the output object

Annotations

@Override

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

private final Class ExternSheetRecord.RefSubRecord

Class Inheritance

extends Object
implements GenericRecord

java.lang.Object
org.apache.poi.hssf.record.ExternSheetRecord.RefSubRecord

All Implemented Interfaces

org.apache.poi.common.usermodel.GenericRecord

Field Summary

Modifier and Type	Field and Description
private final int	_extBookIndex index to External Book Block (which starts with a EXTERNALBOOK record)
private int	_firstSheetIndex
private int	_lastSheetIndex
public static final int	ENCODED_SIZE

Constructor Summary

Access	Constructor and Description
public	RefSubRecord(int extBookIndex, int firstSheetIndex, int lastSheetIndex)
public	RefSubRecord(ExternSheetRecord.RefSubRecord other)
public	RefSubRecord(RecordInputStream the RecordInputstream to read the record from in)

Method Summary

Modifier and Type	Method and Description
public int	getExtBookIndex()
public int	getFirstSheetIndex()
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public int	getLastSheetIndex()
public void	serialize(LittleEndianOutput out)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

_extBookIndex	back to summary
private final int _extBookIndex index to External Book Block (which starts with a EXTERNALBOOK record)

_firstSheetIndex	back to summary
private int _firstSheetIndex

_lastSheetIndex	back to summary
private int _lastSheetIndex

ENCODED_SIZE	back to summary
public static final int ENCODED_SIZE

Constructor Detail

RefSubRecord	back to summary
public RefSubRecord(int extBookIndex, int firstSheetIndex, int lastSheetIndex)

RefSubRecord	back to summary
public RefSubRecord(ExternSheetRecord.RefSubRecord other)

RefSubRecord	back to summary
public RefSubRecord(RecordInputStream in) Parameters in:RecordInputStream the RecordInputstream to read the record from

Method Detail

getExtBookIndex	back to summary
public int getExtBookIndex()

getFirstSheetIndex	back to summary
public int getFirstSheetIndex()

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getLastSheetIndex	back to summary
public int getLastSheetIndex()

serialize	back to summary
public void serialize(LittleEndianOutput out)

toString back to summary

toString	back to summary
public 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 Annotations @Override

public 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

Annotations

@Override

public Class ExternSheetRecord

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ExternSheetRecord.RefSubRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail