|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.LabelSSTRecord
public class 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(RecordInputStream in)
Constructs an LabelSST record and sets its fields appropriately. |
|
| Method Summary | |
|---|---|
java.lang.Object |
clone()
|
int |
compareTo(java.lang.Object obj)
|
boolean |
equals(java.lang.Object obj)
|
protected void |
fillFields(RecordInputStream in)
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. |
int |
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(int 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 |
|---|
cloneViaReserialise, serialize |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final short sid
| Constructor Detail |
|---|
public LabelSSTRecord()
public LabelSSTRecord(RecordInputStream in)
in - the RecordInputstream to read the record from| Method Detail |
|---|
protected void validateSid(short id)
Record
validateSid in class Recordid - alleged id for this recordprotected void fillFields(RecordInputStream in)
Record
fillFields in class Recordin - the RecordInputstream to read the record frompublic void setRow(int row)
CellValueRecordInterface
setRow in interface CellValueRecordInterfacerow - the row this cell occurs withinpublic void setColumn(short col)
CellValueRecordInterface
setColumn in interface CellValueRecordInterfacecol - the column this cell definespublic void setXFIndex(short index)
setXFIndex in interface CellValueRecordInterfaceindex - - the index to the XF recordExtendedFormatRecordpublic void setSSTIndex(int index)
index - - of string in the SST TableSSTRecordpublic int getRow()
CellValueRecordInterface
getRow in interface CellValueRecordInterfacepublic short getColumn()
CellValueRecordInterface
getColumn in interface CellValueRecordInterfacepublic short getXFIndex()
getXFIndex in interface CellValueRecordInterfaceExtendedFormatRecordpublic int getSSTIndex()
SSTRecordpublic java.lang.String toString()
Record
toString in class Record
public int serialize(int offset,
byte[] data)
Record
serialize in class Recordoffset - to begin writing atdata - byte array containing instance data
public int getRecordSize()
Record
getRecordSize in class Recordpublic short getSid()
Record
getSid in class Recordpublic boolean isBefore(CellValueRecordInterface i)
CellValueRecordInterface
isBefore in interface CellValueRecordInterfacei - another cell interface record to compare
public boolean isAfter(CellValueRecordInterface i)
CellValueRecordInterface
isAfter in interface CellValueRecordInterfacei - record to compare
public boolean isEqual(CellValueRecordInterface i)
CellValueRecordInterface
isEqual in interface CellValueRecordInterfacei - record to compare
public boolean isInValueSection()
Record
isInValueSection in class Recordpublic boolean isValue()
Record
isValue in class Recordpublic int compareTo(java.lang.Object obj)
compareTo in interface java.lang.Comparablepublic boolean equals(java.lang.Object obj)
equals in class java.lang.Objectpublic java.lang.Object clone()
clone in interface CellValueRecordInterfaceclone in class Record
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||