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 Details

  • Constructor Details

    • SupBookRecord

      public SupBookRecord(SupBookRecord other)

    • SupBookRecord

      public SupBookRecord(String url, String[] sheetNames)

    • 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 Details

    • 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:
      getDataSize in class StandardRecord

    • serialize

      public void serialize(LittleEndianOutput out)
      Description copied from class: StandardRecord
      Write 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:
      serialize in class StandardRecord
      Parameters:
      out - the output object

    • setNumberOfSheets

      public void setNumberOfSheets(short number)

    • getNumberOfSheets

      public short getNumberOfSheets()

    • 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
      Returns:
      he id for this record

    • getURL

      public String getURL()

    • getSheetNames

      public String[] getSheetNames()

    • setURL

      public void setURL(String pUrl)

    • copy

      public SupBookRecord copy()
      Specified by:
      copy in interface Duplicatable
      Specified by:
      copy in class StandardRecord
      Returns:
      a deep copy of the implementing class / instance

    • getGenericRecordType

      public HSSFRecordTypes getGenericRecordType()
      Specified by:
      getGenericRecordType in interface GenericRecord
      Specified by:
      getGenericRecordType in class Record

    • getGenericProperties

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