org.apache.poi.hssf.record
Class SupBookRecord

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

public final class SupBookRecord
extends Record

Title: Sup Book (EXTERNALBOOK)

Description: A External Workbook Description (Supplemental Book) Its only a dummy record for making new ExternSheet Record

REFERENCE: 5.38

Author:
Libin Roman (Vista Portal LDT. Developer), Andrew C. Oliver (acoliver@apache.org)

Field Summary
static short sid
           
 
Constructor Summary
SupBookRecord(RecordInputStream in)
          called by the constructor, should set class level fields.
SupBookRecord(UnicodeString url, UnicodeString[] sheetNames)
           
 
Method Summary
static SupBookRecord createAddInFunctions()
           
static SupBookRecord createExternalReferences(UnicodeString url, UnicodeString[] sheetNames)
           
static SupBookRecord createInternalReferences(short numberOfSheets)
           
 short getNumberOfSheets()
           
 int getRecordSize()
          gives the current serialized size of the record.
 UnicodeString[] getSheetNames()
           
 short getSid()
          return the non static version of the id for this record.
 java.lang.String getURL()
           
 boolean isAddInFunctions()
           
 boolean isExternalReferences()
           
 boolean isInternalReferences()
           
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 void setNumberOfSheets(short number)
           
 java.lang.String toString()
          get a string representation of the record (for biffview/debugging)
 
Methods inherited from class org.apache.poi.hssf.record.Record
clone, 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

SupBookRecord

public SupBookRecord(UnicodeString url,
                     UnicodeString[] sheetNames)

SupBookRecord

public SupBookRecord(RecordInputStream in)
called by the constructor, should set class level fields. Should throw runtime exception for bad/incomplete data.

Parameters:
data - raw data
size - size of data
offset - of the record's data (provided a big array of the file)
Method Detail

createInternalReferences

public static SupBookRecord createInternalReferences(short numberOfSheets)

createAddInFunctions

public static SupBookRecord createAddInFunctions()

createExternalReferences

public static SupBookRecord createExternalReferences(UnicodeString url,
                                                     UnicodeString[] sheetNames)

isExternalReferences

public boolean isExternalReferences()

isInternalReferences

public boolean isInternalReferences()

isAddInFunctions

public boolean isAddInFunctions()

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

setNumberOfSheets

public void setNumberOfSheets(short number)

getNumberOfSheets

public short getNumberOfSheets()

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

getURL

public java.lang.String getURL()

getSheetNames

public UnicodeString[] getSheetNames()


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