org.apache.poi.hssf.record
Class UnknownRecord

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.UnknownRecord

public final class UnknownRecord
extends Record

Title: Unknown Record (for debugging)

Description: Unknown record just tells you the sid so you can figure out what records you are missing. Also helps us read/modify sheets we don't know all the records to. (HSSF leaves these alone!)

Company: SuperLink Software, Inc.

Author:
Andrew C. Oliver (acoliver at apache dot org), Jason Height (jheight at chariot dot net dot au), Glen Stampoultzis (glens at apache.org)

Field Summary
static int BITMAP_00E9
           
static int LABELRANGES_015F
           
static int PHONETICPR_00EF
           
static int PLS_004D
           
static int QUICKTIP_0800
           
static int RANGEPROTECTION_0868
           
static int SCL_00A0
           
static int SHEETEXT_0862
           
static int SHEETPR_0081
           
static int SHEETPROTECTION_0867
           
static int STANDARDWIDTH_0099
           
 
Constructor Summary
UnknownRecord(int id, byte[] data)
           
UnknownRecord(RecordInputStream in)
          construct an unknown record.
 
Method Summary
 java.lang.Object clone()
           
 int getRecordSize()
          gives the current serialized size of the record.
 short getSid()
          return the non static version of the id for this record.
 int serialize(int offset, byte[] data)
          spit the record out AS IS.
 java.lang.String toString()
          print a sort of string representation ([UNKNOWN RECORD] id = x [/UNKNOWN RECORD])
 
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

PLS_004D

public static final int PLS_004D
See Also:
Constant Field Values

SHEETPR_0081

public static final int SHEETPR_0081
See Also:
Constant Field Values

STANDARDWIDTH_0099

public static final int STANDARDWIDTH_0099
See Also:
Constant Field Values

SCL_00A0

public static final int SCL_00A0
See Also:
Constant Field Values

BITMAP_00E9

public static final int BITMAP_00E9
See Also:
Constant Field Values

PHONETICPR_00EF

public static final int PHONETICPR_00EF
See Also:
Constant Field Values

LABELRANGES_015F

public static final int LABELRANGES_015F
See Also:
Constant Field Values

QUICKTIP_0800

public static final int QUICKTIP_0800
See Also:
Constant Field Values

SHEETEXT_0862

public static final int SHEETEXT_0862
See Also:
Constant Field Values

SHEETPROTECTION_0867

public static final int SHEETPROTECTION_0867
See Also:
Constant Field Values

RANGEPROTECTION_0868

public static final int RANGEPROTECTION_0868
See Also:
Constant Field Values
Constructor Detail

UnknownRecord

public UnknownRecord(int id,
                     byte[] data)
Parameters:
id - id of the record -not validated, just stored for serialization
data - the data

UnknownRecord

public UnknownRecord(RecordInputStream in)
construct an unknown record. No fields are interpreted and the record will be serialized in its original form more or less

Parameters:
in - the RecordInputstream to read the record from
Method Detail

serialize

public final int serialize(int offset,
                           byte[] data)
spit the record out AS IS. no interpretation or identification

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 final 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

toString

public final java.lang.String toString()
print a sort of string representation ([UNKNOWN RECORD] id = x [/UNKNOWN RECORD])

Overrides:
toString in class Record

getSid

public final 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 final java.lang.Object clone()
Overrides:
clone in class Record


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