org.apache.poi.hssf.record
Class LabelSSTRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.RecordBase
      extended by org.apache.poi.hssf.record.Record
          extended by org.apache.poi.hssf.record.LabelSSTRecord
All Implemented Interfaces:
CellValueRecordInterface

public final class LabelSSTRecord
extends Record
implements CellValueRecordInterface

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)

Version:
2.0-pre
Author:
Andrew C. Oliver (acoliver at apache dot org), Jason Height (jheight at chariot dot net dot au)

Field Summary
static short sid
           
 
Constructor Summary
LabelSSTRecord()
           
LabelSSTRecord(RecordInputStream in)
           
 
Method Summary
 java.lang.Object clone()
           
 short getColumn()
           
 int getRecordSize()
          gives the current serialized size of the record.
 int getRow()
           
 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
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 void setColumn(short col)
           
 void setRow(int row)
           
 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)
 
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sid

public static final short sid
See Also:
Constant Field Values
Constructor Detail

LabelSSTRecord

public LabelSSTRecord()

LabelSSTRecord

public LabelSSTRecord(RecordInputStream in)
Method Detail

setRow

public void setRow(int row)
Specified by:
setRow in interface CellValueRecordInterface
Parameters:
row - the row this cell occurs within

setColumn

public void setColumn(short col)
Specified by:
setColumn in interface CellValueRecordInterface
Parameters:
col - the column this cell defines

setXFIndex

public void setXFIndex(short index)
set the index to the extended format record

Specified by:
setXFIndex in interface CellValueRecordInterface
Parameters:
index - - the index to the XF record
See Also:
ExtendedFormatRecord

setSSTIndex

public void setSSTIndex(int index)
set the index to the string in the SSTRecord

Parameters:
index - - of string in the SST Table
See Also:
SSTRecord

getRow

public int getRow()
Specified by:
getRow in interface CellValueRecordInterface
Returns:
the row this cell occurs on

getColumn

public short getColumn()
Specified by:
getColumn in interface CellValueRecordInterface
Returns:
the column this cell defines within the row

getXFIndex

public short getXFIndex()
get the index to the extended format record

Specified by:
getXFIndex in interface CellValueRecordInterface
Returns:
the index to the XF record
See Also:
ExtendedFormatRecord

getSSTIndex

public int getSSTIndex()
get the index to the string in the SSTRecord

Returns:
index of string in the SST Table
See Also:
SSTRecord

toString

public java.lang.String toString()
Description copied from class: Record
get a string representation of the record (for biffview/debugging)

Overrides:
toString in class Record

serialize

public int serialize(int offset,
                     byte[] data)
Description copied from class: RecordBase
called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.

Specified by:
serialize in class RecordBase
Parameters:
offset - to begin writing at
data - byte array containing instance data
Returns:
number of bytes written

getRecordSize

public int getRecordSize()
Description copied from class: Record
gives the current serialized size of the record. Should include the sid and reclength (4 bytes).

Overrides:
getRecordSize in class Record

getSid

public short getSid()
Description copied from class: Record
return the non static version of the id for this record.

Specified by:
getSid in class Record

clone

public java.lang.Object clone()
Overrides:
clone in class Record


Copyright 2008 The Apache Software Foundation or its licensors, as applicable.