org.apache.poi.hssf.record
Class LabelRecord

java.lang.Object
  |
  +--org.apache.poi.hssf.record.Record
        |
        +--org.apache.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 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)

See Also:

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

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
short	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(short row) NO-OP!
void	setXFIndex(short xf) no op!
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, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sid

public static final short sid

Constructor Detail

LabelRecord

public LabelRecord()

Creates new LabelRecord

LabelRecord

public LabelRecord(short id,
                   short size,
                   byte[] data)

Constructs an Label record and sets its fields appropriately.

Parameters:

id - id must be 0x204 or an exception will be throw upon validation

size - the size of the data area of the record

data - data of the record (should not contain sid/len)

LabelRecord

public LabelRecord(short id,
                   short size,
                   byte[] data,
                   int offset)

Constructs an Label record and sets its fields appropriately.

Parameters:

id - id must be 0x204 or an exception will be throw upon validation

size - the size of the data area of the record

data - data of the record (should not contain sid/len)

offset - of the record

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.

Overrides:

validateSid in class Record

Parameters:

id - alleged id for this record

fillFields

protected void fillFields(byte[] data,
                          short size,
                          int offset)

called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.

Overrides:

fillFields in class Record

Parameters:

data - raw data

size - size of data

getRow

public short getRow()

Description copied from interface: CellValueRecordInterface

get the row this cell occurs on

Specified by:

getRow in interface CellValueRecordInterface

Following copied from interface: org.apache.poi.hssf.record.CellValueRecordInterface

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 interface CellValueRecordInterface

Following copied from interface: org.apache.poi.hssf.record.CellValueRecordInterface

Returns:

the column

getXFIndex

public short getXFIndex()

Specified by:

getXFIndex in interface CellValueRecordInterface

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 java.lang.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!!

Overrides:

serialize in class Record

Following copied from class: org.apache.poi.hssf.record.Record

Parameters:

offset - to begin writing at

data - byte array containing instance data

Returns:

number of bytes written

getSid

public short getSid()

Description copied from class: Record

return the non static version of the id for this record.

Overrides:

getSid in class Record

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 interface CellValueRecordInterface

Following copied from interface: org.apache.poi.hssf.record.CellValueRecordInterface

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 interface CellValueRecordInterface

Following copied from interface: org.apache.poi.hssf.record.CellValueRecordInterface

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 interface CellValueRecordInterface

Following copied from interface: org.apache.poi.hssf.record.CellValueRecordInterface

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 class Record

isValue

public boolean isValue()

Description copied from class: Record

tells whether this type of record contains a value

Overrides:

isValue in class Record

setColumn

public void setColumn(short col)

NO-OP!

Specified by:

setColumn in interface CellValueRecordInterface

Following copied from interface: org.apache.poi.hssf.record.CellValueRecordInterface

Parameters:

col - the column this cell defines

setRow

public void setRow(short row)

NO-OP!

Specified by:

setRow in interface CellValueRecordInterface

Following copied from interface: org.apache.poi.hssf.record.CellValueRecordInterface

Parameters:

row - the row this cell occurs within

setXFIndex

public void setXFIndex(short xf)

no op!

Specified by:

setXFIndex in interface CellValueRecordInterface