Package loci.poi.hssf.record
Class LabelRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.LabelRecord
- All Implemented Interfaces:
CellValueRecordInterface
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)
- Version:
- 2.0-pre
- Author:
- Andrew C. Oliver (acoliver at apache dot org), Jason Height (jheight at chariot dot net dot au)
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCreates new LabelRecordConstructs an Label record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.shortget the column this cell defines within the rowintgetRow()get the row this cell occurs onshortgetSid()return the non static version of the id for this record.shortget the number of characters this string containsgetValue()get the valueshortbooleanreturns whether this cell is after the passed in cellbooleanreturns whether this cell is before the passed in cellbooleanreturns whether this cell represents the same cell (NOT VALUE)booleanDBCELL, ROW, VALUES all say yesbooleanis this uncompressed unicode (16bit)? Or just 8-bit compressed?booleanisValue()tells whether this type of record contains a valueintserialize(int offset, byte[] data) THROWS A RUNTIME EXCEPTION..voidsetColumn(short col) NO-OP!voidsetRow(int row) NO-OP!voidsetXFIndex(short xf) no op!toString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(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
getRecordSize, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
LabelRecord
public LabelRecord()Creates new LabelRecord -
LabelRecord
Constructs an Label record and sets its fields appropriately.- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
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:
validateSidin classRecord- Parameters:
id- alleged id for this record
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
getRow
public int getRow()Description copied from interface:CellValueRecordInterfaceget the row this cell occurs on- Specified by:
getRowin interfaceCellValueRecordInterface- Returns:
- the row
-
getColumn
public short getColumn()Description copied from interface:CellValueRecordInterfaceget the column this cell defines within the row- Specified by:
getColumnin interfaceCellValueRecordInterface- Returns:
- the column
-
getXFIndex
public short getXFIndex()- Specified by:
getXFIndexin interfaceCellValueRecordInterface
-
getStringLength
public short getStringLength()get the number of characters this string contains- Returns:
- number of characters
-
isUnCompressedUnicode
public boolean isUnCompressedUnicode()is this uncompressed unicode (16bit)? Or just 8-bit compressed?- Returns:
- isUnicode - True for 16bit- false for 8bit
-
getValue
get the value- Returns:
- the text string
- See Also:
-
serialize
public int serialize(int offset, byte[] data) THROWS A RUNTIME EXCEPTION.. USE LABELSSTRecords. YOU HAVE NO REASON to use LABELRecord!! -
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
isBefore
Description copied from interface:CellValueRecordInterfacereturns whether this cell is before the passed in cell- Specified by:
isBeforein interfaceCellValueRecordInterface- Parameters:
i- another cell interface record to compare- Returns:
- true if the cells is before, or false if not
-
isAfter
Description copied from interface:CellValueRecordInterfacereturns whether this cell is after the passed in cell- Specified by:
isAfterin interfaceCellValueRecordInterface- Parameters:
i- record to compare- Returns:
- true if the cell is after, false if not
-
isEqual
Description copied from interface:CellValueRecordInterfacereturns whether this cell represents the same cell (NOT VALUE)- Specified by:
isEqualin interfaceCellValueRecordInterface- Parameters:
i- record to compare- Returns:
- true if the cells are the same cell (positionally), false if not.
-
isInValueSection
public boolean isInValueSection()Description copied from class:RecordDBCELL, ROW, VALUES all say yes- Overrides:
isInValueSectionin classRecord
-
isValue
public boolean isValue()Description copied from class:Recordtells whether this type of record contains a value -
setColumn
public void setColumn(short col) NO-OP!- Specified by:
setColumnin interfaceCellValueRecordInterface- Parameters:
col- the column this cell defines
-
setRow
public void setRow(int row) NO-OP!- Specified by:
setRowin interfaceCellValueRecordInterface- Parameters:
row- the row this cell occurs within
-
setXFIndex
public void setXFIndex(short xf) no op!- Specified by:
setXFIndexin interfaceCellValueRecordInterface
-
clone
- Specified by:
clonein interfaceCellValueRecordInterface- Overrides:
clonein classRecord
-