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 and Description
static short	sid

Constructor Summary

Constructors

Constructor and Description
SupBookRecord(RecordInputStream in) called by the constructor, should set class level fields.
SupBookRecord(java.lang.String url, java.lang.String[] sheetNames)
SupBookRecord(SupBookRecord other)

Method Summary

Modifier and Type	Method and Description
SupBookRecord	copy()
static SupBookRecord	createAddInFunctions()
static SupBookRecord	createExternalReferences(java.lang.String url, java.lang.String[] sheetNames)
static SupBookRecord	createInternalReferences(short numberOfSheets)
protected int	getDataSize()
java.util.Map<java.lang.String,java.util.function.Supplier<?>>	getGenericProperties()
HSSFRecordTypes	getGenericRecordType()
short	getNumberOfSheets()
java.lang.String[]	getSheetNames()
short	getSid() return the non static version of the id for this record.
java.lang.String	getURL()
boolean	isAddInFunctions()
boolean	isExternalReferences()
boolean	isInternalReferences()
void	serialize(LittleEndianOutput out) Write the data content of this BIFF record.
void	setNumberOfSheets(short number)
void	setURL(java.lang.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(java.lang.String url,
                     java.lang.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 Detail

createInternalReferences

public static SupBookRecord createInternalReferences(short numberOfSheets)

createAddInFunctions

public static SupBookRecord createAddInFunctions()

createExternalReferences

public static SupBookRecord createExternalReferences(java.lang.String url,
                                                     java.lang.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 java.lang.String getURL()

getSheetNames

public java.lang.String[] getSheetNames()

setURL

public void setURL(java.lang.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 java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()