|
|||||||||||
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.LabelRecord
Label Record - read only support for strings stored directly in the cell.. Don't use this (except to read), use LabelSST instead
REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
LabelSSTRecord
Field Summary | |
static short |
sid
|
Constructor Summary | |
LabelRecord()
Creates new LabelRecord |
|
LabelRecord(short id,
short size,
byte[] data)
Constructs an Label record and sets its fields appropriately. |
|
LabelRecord(short id,
short size,
byte[] data,
int offset)
Constructs an Label record and sets its fields appropriately. |
Method Summary | |
java.lang.Object |
clone()
|
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 |
getRow()
get the row this cell occurs on |
short |
getSid()
return the non static version of the id for this record. |
short |
getStringLength()
get the number of characters this string contains |
java.lang.String |
getValue()
get the value |
short |
getXFIndex()
|
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 |
isUnCompressedUnicode()
is this uncompressed unicode (16bit)? Or just 8-bit compressed? |
boolean |
isValue()
tells whether this type of record contains a value |
int |
serialize(int offset,
byte[] data)
THROWS A RUNTIME EXCEPTION.. |
void |
setColumn(short col)
NO-OP! |
void |
setRow(int row)
NO-OP! |
void |
setXFIndex(short xf)
no op! |
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, getRecordSize, processContinueRecord, serialize |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final short sid
Constructor Detail |
public LabelRecord()
public LabelRecord(short id, short size, byte[] data)
id
- id must be 0x204 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 LabelRecord(short id, short size, byte[] data, int offset)
id
- id must be 0x204 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 recordMethod Detail |
protected void validateSid(short id)
validateSid
in class Record
id
- alleged id for this recordprotected void fillFields(byte[] data, short size, int offset)
fillFields
in class Record
data
- raw datasize
- size of dataoffset
- of the record's data (provided a big array of the file)public int getRow()
CellValueRecordInterface
getRow
in interface CellValueRecordInterface
public short getColumn()
CellValueRecordInterface
getColumn
in interface CellValueRecordInterface
public short getXFIndex()
getXFIndex
in interface CellValueRecordInterface
public short getStringLength()
public boolean isUnCompressedUnicode()
public java.lang.String getValue()
getStringLength()
public int serialize(int offset, byte[] data)
serialize
in class Record
offset
- to begin writing atdata
- byte array containing instance data
public short getSid()
Record
getSid
in class Record
public java.lang.String toString()
Record
toString
in class Record
public boolean isBefore(CellValueRecordInterface i)
CellValueRecordInterface
isBefore
in interface CellValueRecordInterface
i
- another cell interface record to compare
public boolean isAfter(CellValueRecordInterface i)
CellValueRecordInterface
isAfter
in interface CellValueRecordInterface
i
- record to compare
public boolean isEqual(CellValueRecordInterface i)
CellValueRecordInterface
isEqual
in interface CellValueRecordInterface
i
- record to compare
public boolean isInValueSection()
Record
isInValueSection
in class Record
public boolean isValue()
Record
isValue
in class Record
public void setColumn(short col)
setColumn
in interface CellValueRecordInterface
col
- the column this cell definespublic void setRow(int row)
setRow
in interface CellValueRecordInterface
row
- the row this cell occurs withinpublic void setXFIndex(short xf)
setXFIndex
in interface CellValueRecordInterface
public java.lang.Object clone()
clone
in interface CellValueRecordInterface
clone
in class Record
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |