|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.poi.hssf.record.Record | +--org.apache.poi.hssf.record.LabelSSTRecord
Title: Label SST Record
Description: Refers to a string in the shared string table and is a column value.
REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
Field Summary | |
static short |
sid
|
Constructor Summary | |
LabelSSTRecord()
|
|
LabelSSTRecord(short id,
short size,
byte[] data)
Constructs an LabelSST record and sets its fields appropriately. |
|
LabelSSTRecord(short id,
short size,
byte[] data,
int offset)
Constructs an LabelSST record and sets its fields appropriately. |
Method Summary | |
int |
compareTo(java.lang.Object obj)
|
boolean |
equals(java.lang.Object obj)
|
protected void |
fillFields(byte[] data,
short size,
int offset)
called by the constructor, should set class level fields. |
short |
getColumn()
get the column this cell defines within the row |
int |
getRecordSize()
gives the current serialized size of the record. |
short |
getRow()
get the row this cell occurs on |
short |
getSid()
return the non static version of the id for this record. |
int |
getSSTIndex()
get the index to the string in the SSTRecord |
short |
getXFIndex()
get the index to the extended format record |
boolean |
isAfter(CellValueRecordInterface i)
returns whether this cell is after the passed in cell |
boolean |
isBefore(CellValueRecordInterface i)
returns whether this cell is before the passed in cell |
boolean |
isEqual(CellValueRecordInterface i)
returns whether this cell represents the same cell (NOT VALUE) |
boolean |
isInValueSection()
DBCELL, ROW, VALUES all say yes |
boolean |
isValue()
tells whether this type of record contains a value |
int |
serialize(int offset,
byte[] data)
called by the class that is responsible for writing this sucker. |
void |
setColumn(short col)
set the column this cell defines within the row |
void |
setRow(short row)
set the row this cell occurs on |
void |
setSSTIndex(int index)
set the index to the string in the SSTRecord |
void |
setXFIndex(short index)
set the index to the extended format record |
java.lang.String |
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 org.apache.poi.hssf.record.Record |
fillFields, processContinueRecord, serialize |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final short sid
Constructor Detail |
public LabelSSTRecord()
public LabelSSTRecord(short id, short size, byte[] data)
id
- id must be 0xfd or an exception will be throw upon validationsize
- the size of the data area of the recorddata
- data of the record (should not contain sid/len)public LabelSSTRecord(short id, short size, byte[] data, int offset)
id
- id must be 0xfd or an exception will be throw upon validationsize
- the size of the data area of the recorddata
- data of the record (should not contain sid/len)offset
- of the record's dataMethod Detail |
protected void validateSid(short id)
Record
validateSid
in class Record
org.apache.poi.hssf.record.Record
id
- alleged id for this recordprotected void fillFields(byte[] data, short size, int offset)
Record
fillFields
in class Record
org.apache.poi.hssf.record.Record
data
- raw datasize
- size of dataoffset
- of the record's data (provided a big array of the file)public void setRow(short row)
CellValueRecordInterface
setRow
in interface CellValueRecordInterface
org.apache.poi.hssf.record.CellValueRecordInterface
row
- the row this cell occurs withinpublic void setColumn(short col)
CellValueRecordInterface
setColumn
in interface CellValueRecordInterface
org.apache.poi.hssf.record.CellValueRecordInterface
col
- the column this cell definespublic void setXFIndex(short index)
setXFIndex
in interface CellValueRecordInterface
index
- - the index to the XF recordExtendedFormatRecord
public void setSSTIndex(int index)
index
- - of string in the SST TableSSTRecord
public short getRow()
CellValueRecordInterface
getRow
in interface CellValueRecordInterface
org.apache.poi.hssf.record.CellValueRecordInterface
public short getColumn()
CellValueRecordInterface
getColumn
in interface CellValueRecordInterface
org.apache.poi.hssf.record.CellValueRecordInterface
public short getXFIndex()
getXFIndex
in interface CellValueRecordInterface
ExtendedFormatRecord
public int getSSTIndex()
SSTRecord
public java.lang.String toString()
Record
toString
in class Record
public int serialize(int offset, byte[] data)
Record
serialize
in class Record
org.apache.poi.hssf.record.Record
offset
- to begin writing atdata
- byte array containing instance datapublic int getRecordSize()
Record
getRecordSize
in class Record
public short getSid()
Record
getSid
in class Record
public boolean isBefore(CellValueRecordInterface i)
CellValueRecordInterface
isBefore
in interface CellValueRecordInterface
org.apache.poi.hssf.record.CellValueRecordInterface
i
- another cell interface record to comparepublic boolean isAfter(CellValueRecordInterface i)
CellValueRecordInterface
isAfter
in interface CellValueRecordInterface
org.apache.poi.hssf.record.CellValueRecordInterface
i
- record to comparepublic boolean isEqual(CellValueRecordInterface i)
CellValueRecordInterface
isEqual
in interface CellValueRecordInterface
org.apache.poi.hssf.record.CellValueRecordInterface
i
- record to comparepublic boolean isInValueSection()
Record
isInValueSection
in class Record
public boolean isValue()
Record
isValue
in class Record
public int compareTo(java.lang.Object obj)
compareTo
in interface java.lang.Comparable
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |