Package org.apache.poi.hssf.record
Class SupBookRecord
- java.lang.Object
-
- org.apache.poi.hssf.record.RecordBase
-
- org.apache.poi.hssf.record.Record
-
- org.apache.poi.hssf.record.StandardRecord
-
- org.apache.poi.hssf.record.SupBookRecord
-
- All Implemented Interfaces:
Duplicatable,GenericRecord
public final class SupBookRecord extends StandardRecord
A External Workbook Description (Supplemental Book). Its only a dummy record for making new ExternSheet Record
-
-
Field Summary
Fields Modifier and Type Field Description static shortsid
-
Constructor Summary
Constructors Constructor Description SupBookRecord(String url, String[] sheetNames)SupBookRecord(RecordInputStream in)called by the constructor, should set class level fields.SupBookRecord(SupBookRecord other)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SupBookRecordcopy()static SupBookRecordcreateAddInFunctions()static SupBookRecordcreateExternalReferences(String url, String[] sheetNames)static SupBookRecordcreateInternalReferences(short numberOfSheets)protected intgetDataSize()Map<String,Supplier<?>>getGenericProperties()HSSFRecordTypesgetGenericRecordType()shortgetNumberOfSheets()String[]getSheetNames()shortgetSid()return the non static version of the id for this record.StringgetURL()booleanisAddInFunctions()booleanisExternalReferences()booleanisInternalReferences()voidserialize(LittleEndianOutput out)Write the data content of this BIFF record.voidsetNumberOfSheets(short number)voidsetURL(String pUrl)-
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
-
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord
getGenericChildren
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
SupBookRecord
public SupBookRecord(SupBookRecord other)
-
SupBookRecord
public SupBookRecord(RecordInputStream in)
called by the constructor, should set class level fields. Should throw runtime exception for bad/incomplete data.- Parameters:
in- the stream to read from
-
-
Method Detail
-
createInternalReferences
public static SupBookRecord createInternalReferences(short numberOfSheets)
-
createAddInFunctions
public static SupBookRecord createAddInFunctions()
-
createExternalReferences
public static SupBookRecord createExternalReferences(String url, String[] sheetNames)
-
isExternalReferences
public boolean isExternalReferences()
-
isInternalReferences
public boolean isInternalReferences()
-
isAddInFunctions
public boolean isAddInFunctions()
-
getDataSize
protected int getDataSize()
- Specified by:
getDataSizein classStandardRecord
-
serialize
public void serialize(LittleEndianOutput out)
Description copied from class:StandardRecordWrite the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.The number of bytes written must equal the record size reported by
RecordBase.getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serializein classStandardRecord- Parameters:
out- the output object
-
setNumberOfSheets
public void setNumberOfSheets(short number)
-
getNumberOfSheets
public short getNumberOfSheets()
-
getSid
public short getSid()
Description copied from class:Recordreturn the non static version of the id for this record.
-
getURL
public String getURL()
-
getSheetNames
public String[] getSheetNames()
-
setURL
public void setURL(String pUrl)
-
copy
public SupBookRecord copy()
- Specified by:
copyin interfaceDuplicatable- Specified by:
copyin classStandardRecord- Returns:
- a deep copy of the implementing class / instance
-
getGenericRecordType
public HSSFRecordTypes getGenericRecordType()
- Specified by:
getGenericRecordTypein interfaceGenericRecord- Specified by:
getGenericRecordTypein classRecord
-
-