Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public final Class LabelRecord

extends Record
implements CellValueRecordInterface
Class Inheritance
All Implemented Interfaces
org.apache.poi.hssf.record.CellValueRecordInterface
Imports
java.util.Map, java.util.function.Supplier, org.apache.logging.log4j.LogManager, .Logger, org.apache.poi.util.GenericRecordUtil, .RecordFormatException
Label Record (0x0204) - read only support for strings stored directly in the cell... Don't use this (except to read), use LabelSST instead
See Also
LabelSSTRecord

Field Summary

Modifier and TypeField and Description
private int
field_1_row

private short
field_2_column

private short
field_3_xf_index

private short
field_4_string_len

private byte
field_5_unicode_flag

private String
field_6_value

private static final Logger
LOG

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
LabelRecord()

Creates new LabelRecord

public
LabelRecord(LabelRecord other)

public
LabelRecord(RecordInputStream
the RecordInputstream to read the record from
in)

Method Summary

Modifier and TypeMethod and Description
public LabelRecord
copy()

Implements abstract org.apache.poi.hssf.record.Record.copy.

Implements org.apache.poi.common.Duplicatable.copy.

public short
getColumn()

Implements org.apache.poi.hssf.record.CellValueRecordInterface.getColumn.

public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public HSSFRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

public int
getRecordSize()

Implements abstract org.apache.poi.hssf.record.RecordBase.getRecordSize.

gives the current serialized size of the record.

public int
getRow()

Implements org.apache.poi.hssf.record.CellValueRecordInterface.getRow.

public short
getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

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

public short

Returns:

number of characters
getStringLength()

get the number of characters this string contains

public String

Returns:

the text string
getValue()

get the value

public short
getXFIndex()

Implements org.apache.poi.hssf.record.CellValueRecordInterface.getXFIndex.

public boolean

Returns:

isUnicode - True for 16bit- false for 8bit
isUnCompressedUnicode()

is this uncompressed unicode (16bit)?

public int
serialize(int
to begin writing at
offset, byte[]
byte array containing instance data
data)

Implements abstract org.apache.poi.hssf.record.RecordBase.serialize.

THROWS A RUNTIME EXCEPTION..

public void
setColumn(short
the column this cell defines
col)

Implements org.apache.poi.hssf.record.CellValueRecordInterface.setColumn.

NO-OP!

public void
setRow(int
the row this cell occurs within
row)

Implements org.apache.poi.hssf.record.CellValueRecordInterface.setRow.

NO-OP!

public void
setXFIndex(short xf)

Implements org.apache.poi.hssf.record.CellValueRecordInterface.setXFIndex.

no op!

Inherited from org.apache.poi.hssf.record.Record:
cloneViaReserialiseserializetoString

Field Detail

field_1_rowback to summary
private int field_1_row
field_2_columnback to summary
private short field_2_column
field_3_xf_indexback to summary
private short field_3_xf_index
field_4_string_lenback to summary
private short field_4_string_len
field_5_unicode_flagback to summary
private byte field_5_unicode_flag
field_6_valueback to summary
private String field_6_value
LOGback to summary
private static final Logger LOG
sidback to summary
public static final short sid

Constructor Detail

LabelRecordback to summary
public LabelRecord()

Creates new LabelRecord

LabelRecordback to summary
public LabelRecord(LabelRecord other)
LabelRecordback to summary
public LabelRecord(RecordInputStream in)
Parameters
in:RecordInputStream

the RecordInputstream to read the record from

Method Detail

copyback to summary
public LabelRecord copy()

Implements abstract org.apache.poi.hssf.record.Record.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:LabelRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getColumnback to summary
public short getColumn()

Implements org.apache.poi.hssf.record.CellValueRecordInterface.getColumn.

Returns:short

Doc from org.apache.poi.hssf.record.CellValueRecordInterface.getColumn.

the column this cell defines within the row

Annotations
@Override
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations
@Override
getRecordSizeback to summary
public int getRecordSize()

Implements abstract org.apache.poi.hssf.record.RecordBase.getRecordSize.

Doc from org.apache.poi.hssf.record.RecordBase.getRecordSize.

gives the current serialized size of the record. Should include the sid and reclength (4 bytes).

Returns:int

the record size

Annotations
@Override
getRowback to summary
public int getRow()

Implements org.apache.poi.hssf.record.CellValueRecordInterface.getRow.

Returns:int

Doc from org.apache.poi.hssf.record.CellValueRecordInterface.getRow.

the row this cell occurs on

Annotations
@Override
getSidback to summary
public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

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

Returns:short

he id for this record

Annotations
@Override
getStringLengthback to summary
public short getStringLength()

get the number of characters this string contains

Returns:short

number of characters

getValueback to summary
public String getValue()

get the value

Returns:String

the text string

See Also
getStringLength()
getXFIndexback to summary
public short getXFIndex()

Implements org.apache.poi.hssf.record.CellValueRecordInterface.getXFIndex.

Annotations
@Override
isUnCompressedUnicodeback to summary
public boolean isUnCompressedUnicode()

is this uncompressed unicode (16bit)? Or just 8-bit compressed?

Returns:boolean

isUnicode - True for 16bit- false for 8bit

serializeback to summary
public int serialize(int offset, byte[] data)

Implements abstract org.apache.poi.hssf.record.RecordBase.serialize.

THROWS A RUNTIME EXCEPTION.. USE LABELSSTRecords. YOU HAVE NO REASON to use LABELRecord!!

Parameters
offset:int

Doc from org.apache.poi.hssf.record.RecordBase.serialize.

to begin writing at

data:byte[]

Doc from org.apache.poi.hssf.record.RecordBase.serialize.

byte array containing instance data

Returns:int

Doc from org.apache.poi.hssf.record.RecordBase.serialize.

number of bytes written

Annotations
@Override
setColumnback to summary
public void setColumn(short col)

Implements org.apache.poi.hssf.record.CellValueRecordInterface.setColumn.

NO-OP!

Parameters
col:short

Doc from org.apache.poi.hssf.record.CellValueRecordInterface.setColumn.

the column this cell defines

Annotations
@Override
setRowback to summary
public void setRow(int row)

Implements org.apache.poi.hssf.record.CellValueRecordInterface.setRow.

NO-OP!

Parameters
row:int

Doc from org.apache.poi.hssf.record.CellValueRecordInterface.setRow.

the row this cell occurs within

Annotations
@Override
setXFIndexback to summary
public void setXFIndex(short xf)

Implements org.apache.poi.hssf.record.CellValueRecordInterface.setXFIndex.

no op!

Annotations
@Override