Package loci.poi.hssf.record
Class LabelRecord
- java.lang.Object
-
- loci.poi.hssf.record.Record
-
- loci.poi.hssf.record.LabelRecord
-
- All Implemented Interfaces:
CellValueRecordInterface
public class LabelRecord extends Record implements CellValueRecordInterface
Label Record - read only support for strings stored directly in the cell.. Don't use this (except to read), use LabelSST insteadREFERENCE: 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:
LabelSSTRecord
-
-
Field Summary
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description LabelRecord()
Creates new LabelRecordLabelRecord(RecordInputStream in)
Constructs an Label record and sets its fields appropriately.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
clone()
protected void
fillFields(RecordInputStream in)
called by the constructor, should set class level fields.short
getColumn()
get the column this cell defines within the rowint
getRow()
get the row this cell occurs onshort
getSid()
return the non static version of the id for this record.short
getStringLength()
get the number of characters this string containsString
getValue()
get the valueshort
getXFIndex()
boolean
isAfter(CellValueRecordInterface i)
returns whether this cell is after the passed in cellboolean
isBefore(CellValueRecordInterface i)
returns whether this cell is before the passed in cellboolean
isEqual(CellValueRecordInterface i)
returns whether this cell represents the same cell (NOT VALUE)boolean
isInValueSection()
DBCELL, ROW, VALUES all say yesboolean
isUnCompressedUnicode()
is this uncompressed unicode (16bit)? Or just 8-bit compressed?boolean
isValue()
tells whether this type of record contains a valueint
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!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 loci.poi.hssf.record.Record
getRecordSize, serialize
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
LabelRecord
public LabelRecord()
Creates new LabelRecord
-
LabelRecord
public LabelRecord(RecordInputStream in)
Constructs an Label record and sets its fields appropriately.- Parameters:
in
- the RecordInputstream to read the record from
-
-
Method Detail
-
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
-
getRow
public int getRow()
Description copied from interface:CellValueRecordInterface
get the row this cell occurs on- Specified by:
getRow
in interfaceCellValueRecordInterface
- Returns:
- the row
-
getColumn
public short getColumn()
Description copied from interface:CellValueRecordInterface
get the column this cell defines within the row- Specified by:
getColumn
in interfaceCellValueRecordInterface
- Returns:
- the column
-
getXFIndex
public short getXFIndex()
- Specified by:
getXFIndex
in 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
public String getValue()
get the value- Returns:
- the text string
- See Also:
getStringLength()
-
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:Record
return the non static version of the id for this record.
-
toString
public String toString()
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-
isBefore
public boolean isBefore(CellValueRecordInterface i)
Description copied from interface:CellValueRecordInterface
returns whether this cell is before the passed in cell- Specified by:
isBefore
in interfaceCellValueRecordInterface
- Parameters:
i
- another cell interface record to compare- Returns:
- true if the cells is before, or false if not
-
isAfter
public boolean isAfter(CellValueRecordInterface i)
Description copied from interface:CellValueRecordInterface
returns whether this cell is after the passed in cell- Specified by:
isAfter
in interfaceCellValueRecordInterface
- Parameters:
i
- record to compare- Returns:
- true if the cell is after, false if not
-
isEqual
public boolean isEqual(CellValueRecordInterface i)
Description copied from interface:CellValueRecordInterface
returns whether this cell represents the same cell (NOT VALUE)- Specified by:
isEqual
in 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:Record
DBCELL, ROW, VALUES all say yes- Overrides:
isInValueSection
in classRecord
-
isValue
public boolean isValue()
Description copied from class:Record
tells whether this type of record contains a value
-
setColumn
public void setColumn(short col)
NO-OP!- Specified by:
setColumn
in interfaceCellValueRecordInterface
- Parameters:
col
- the column this cell defines
-
setRow
public void setRow(int row)
NO-OP!- Specified by:
setRow
in interfaceCellValueRecordInterface
- Parameters:
row
- the row this cell occurs within
-
setXFIndex
public void setXFIndex(short xf)
no op!- Specified by:
setXFIndex
in interfaceCellValueRecordInterface
-
clone
public Object clone()
- Specified by:
clone
in interfaceCellValueRecordInterface
- Overrides:
clone
in classRecord
-
-