Package loci.poi.hssf.record
Class ExternSheetSubRecord
- java.lang.Object
-
- loci.poi.hssf.record.Record
-
- loci.poi.hssf.record.ExternSheetSubRecord
-
public class ExternSheetSubRecord extends Record
Title: A sub Record for Extern SheetDescription: Defines a named range within a workbook.
REFERENCE:
- Version:
- 1.0-pre
- Author:
- Libin Roman (Vista Portal LDT. Developer)
-
-
Field Summary
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description ExternSheetSubRecord()
a Constractor for making new sub recordExternSheetSubRecord(RecordInputStream in)
Constructs a Extern Sheet Sub Record record and sets its fields appropriately.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
fillFields(RecordInputStream in)
called by the constructor, should set class level fields.short
getIndexToFirstSupBook()
gets the index to first sheet from supbookshort
getIndexToLastSupBook()
gets the index to last sheet in supbookshort
getIndexToSupBook()
gets the index to sup bookint
getRecordSize()
returns the record sizeshort
getSid()
return the non static version of the id for this record.int
serialize(int offset, byte[] data)
called by the class that is responsible for writing this sucker.void
setIndexToFirstSupBook(short index)
sets the index to first sheet in supbookvoid
setIndexToLastSupBook(short index)
sets the index to last sheet in supbookvoid
setIndexToSupBook(short index)
Sets the Index to the sup bookString
toString()
get a string representation of the record (for biffview/debugging)protected void
validateSid(short id)
called by constructor, should throw runtime exception in the event of a record passed with a differing ID.-
Methods inherited from class loci.poi.hssf.record.Record
clone, isInValueSection, isValue, serialize
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ExternSheetSubRecord
public ExternSheetSubRecord()
a Constractor for making new sub record
-
ExternSheetSubRecord
public ExternSheetSubRecord(RecordInputStream in)
Constructs a Extern Sheet Sub Record record and sets its fields appropriately.- Parameters:
in
- the RecordInputstream to read the record from
-
-
Method Detail
-
setIndexToSupBook
public void setIndexToSupBook(short index)
Sets the Index to the sup book- Parameters:
index
- sup book index
-
getIndexToSupBook
public short getIndexToSupBook()
gets the index to sup book- Returns:
- sup book index
-
setIndexToFirstSupBook
public void setIndexToFirstSupBook(short index)
sets the index to first sheet in supbook- Parameters:
index
- index to first sheet
-
getIndexToFirstSupBook
public short getIndexToFirstSupBook()
gets the index to first sheet from supbook- Returns:
- index to first supbook
-
setIndexToLastSupBook
public void setIndexToLastSupBook(short index)
sets the index to last sheet in supbook- Parameters:
index
- index to last sheet
-
getIndexToLastSupBook
public short getIndexToLastSupBook()
gets the index to last sheet in supbook- Returns:
- index to last supbook
-
validateSid
protected void validateSid(short id)
called by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSid
in classRecord
- Parameters:
id
- alleged id for this record
-
fillFields
protected void fillFields(RecordInputStream in)
Description copied from class:Record
called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFields
in classRecord
- Parameters:
in
- the RecordInputstream to read the record from
-
toString
public String toString()
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-
serialize
public int serialize(int offset, byte[] data)
called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.
-
getRecordSize
public int getRecordSize()
returns the record size- Overrides:
getRecordSize
in classRecord
-
-