Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.SupBookRecord

Field Summary

Modifier and Type	Field and Description
private final boolean	_isAddInFunctions
pack-priv static final char	CH_ALT_STARTUP_DIR
pack-priv static final char	CH_DOWN_DIR
pack-priv static final char	CH_LIB_DIR
pack-priv static final char	CH_LONG_VOLUME
pack-priv static final char	CH_SAME_VOLUME
pack-priv static final char	CH_STARTUP_DIR
pack-priv static final char	CH_UP_DIR
pack-priv static final char	CH_VOLUME
private short	field_1_number_of_sheets
private String	field_2_encoded_url
private final String[]	field_3_sheet_names
private static final Logger	LOG
pack-priv static final String	PATH_SEPERATOR
public static final short	sid
private static final short	SMALL_RECORD_SIZE
private static final short	TAG_ADD_IN_FUNCTIONS
private static final short	TAG_INTERNAL_REFERENCES

Constructor Summary

Access	Constructor and Description
public	SupBookRecord(SupBookRecord other)
private	SupBookRecord(boolean isAddInFuncs, short numberOfSheets)
public	SupBookRecord(String url, String[] sheetNames)
public	SupBookRecord(RecordInputStream the stream to read from in) called by the constructor, should set class level fields.

Method Summary

Modifier and Type	Method and Description
public SupBookRecord	copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy.
public static SupBookRecord	createAddInFunctions()
public static SupBookRecord	createExternalReferences(String url, String[] sheetNames)
public static SupBookRecord	createInternalReferences(short numberOfSheets)
private static String	decodeFileName(String encodedUrl)
protected int	getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public HSSFRecordTypes	getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.
public short	getNumberOfSheets()
public String[]	getSheetNames()
public short	getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record.
public String	getURL()
public boolean	isAddInFunctions()
public boolean	isExternalReferences()
public boolean	isInternalReferences()
public void	serialize(LittleEndianOutput the output object out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Write the data content of this BIFF record.
public void	setNumberOfSheets(short number)
public void	setURL(String pUrl)

Inherited from org.apache.poi.hssf.record.StandardRecord:: getRecordSize serialize

Field Detail

_isAddInFunctions	back to summary
private final boolean _isAddInFunctions

CH_ALT_STARTUP_DIR	back to summary
pack-priv static final char CH_ALT_STARTUP_DIR

CH_DOWN_DIR	back to summary
pack-priv static final char CH_DOWN_DIR

CH_LIB_DIR	back to summary
pack-priv static final char CH_LIB_DIR

CH_LONG_VOLUME	back to summary
pack-priv static final char CH_LONG_VOLUME

CH_SAME_VOLUME	back to summary
pack-priv static final char CH_SAME_VOLUME

CH_STARTUP_DIR	back to summary
pack-priv static final char CH_STARTUP_DIR

CH_UP_DIR	back to summary
pack-priv static final char CH_UP_DIR

CH_VOLUME	back to summary
pack-priv static final char CH_VOLUME

field_1_number_of_sheets	back to summary
private short field_1_number_of_sheets

field_2_encoded_url	back to summary
private String field_2_encoded_url

field_3_sheet_names	back to summary
private final String[] field_3_sheet_names

LOG	back to summary
private static final Logger LOG

PATH_SEPERATOR	back to summary
pack-priv static final String PATH_SEPERATOR

sid	back to summary
public static final short sid

SMALL_RECORD_SIZE	back to summary
private static final short SMALL_RECORD_SIZE

TAG_ADD_IN_FUNCTIONS	back to summary
private static final short TAG_ADD_IN_FUNCTIONS

TAG_INTERNAL_REFERENCES	back to summary
private static final short TAG_INTERNAL_REFERENCES

Constructor Detail

SupBookRecord	back to summary
public SupBookRecord(SupBookRecord other)

SupBookRecord	back to summary
private SupBookRecord(boolean isAddInFuncs, short numberOfSheets)

SupBookRecord	back to summary
public SupBookRecord(String url, String[] sheetNames)

SupBookRecord	back to summary
public SupBookRecord(RecordInputStream in) called by the constructor, should set class level fields. Should throw runtime exception for bad/incomplete data. Parameters in:RecordInputStream the stream to read from

SupBookRecord

back to summary

public SupBookRecord(RecordInputStream in)

called by the constructor, should set class level fields. Should throw runtime exception for bad/incomplete data.

Parameters

in:RecordInputStream: the stream to read from

Method Detail

copy	back to summary
public SupBookRecord copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy. Returns:SupBookRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public SupBookRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:SupBookRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations

@Override

createAddInFunctions	back to summary
public static SupBookRecord createAddInFunctions()

createExternalReferences	back to summary
public static SupBookRecord createExternalReferences(String url, String[] sheetNames)

createInternalReferences	back to summary
public static SupBookRecord createInternalReferences(short numberOfSheets)

decodeFileName	back to summary
private static String decodeFileName(String encodedUrl)

getDataSize	back to summary
protected int getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

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

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getGenericRecordType	back to summary
public HSSFRecordTypes getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType. Annotations @Override

getGenericRecordType

back to summary

public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations

@Override

getNumberOfSheets	back to summary
public short getNumberOfSheets()

getSheetNames	back to summary
public String[] getSheetNames()

getSid	back to summary
public short getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. Doc from org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record. Returns:short he id for this record

getSid

back to summary

public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short: he id for this record

getURL	back to summary
public String getURL()

isAddInFunctions	back to summary
public boolean isAddInFunctions()

isExternalReferences	back to summary
public boolean isExternalReferences()

isInternalReferences	back to summary
public boolean isInternalReferences()

serialize back to summary

serialize	back to summary
public void serialize(LittleEndianOutput out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Doc from org.apache.poi.hssf.record.StandardRecord.serialize. 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 `org.apache.poi.hssf.record.Record#getRecordSize()`} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass). Parameters out:LittleEndianOutput the output object

public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

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 org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters

out:LittleEndianOutput: the output object

setNumberOfSheets	back to summary
public void setNumberOfSheets(short number)

setURL	back to summary
public void setURL(String pUrl)

public final Class SupBookRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail