Package org.apache.poi.hssf.record

Class MTRSettingsRecord

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

All Implemented Interfaces:

Duplicatable, GenericRecord

public class MTRSettingsRecord
extends StandardRecord

[MS-XLS].pdf 2.4.173 MTRSettings page 343 Multithreaded calculation settings.

Author:

henrichen@zkoss.org

Field Summary

Fields

Modifier and Type	Field	Description
static short	sid

Constructor Summary

Constructors

Constructor	Description
MTRSettingsRecord()
MTRSettingsRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method	Description
Object	clone()
MTRSettingsRecord	copy()
protected int	getDataSize()
Map<String,Supplier<?>>	getGenericProperties()
HSSFRecordTypes	getGenericRecordType()
short	getSid()	return the non static version of the id for this record.
int	getUserThreadCount()	Returns count of calculation threads.
boolean	isMTREnabled()	Returns whether the multi-threaded calculation is enabled.
boolean	isUserSetThreadCount()	Returns whether the thread count was manually specified by the user.
void	serialize(LittleEndianOutput out)	Write the data content of this BIFF record.
void	setMTREnabled(boolean flag)
void	setUserSetThreadCount(boolean flag)
void	setUserThreadCount(int count)

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

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

MTRSettingsRecord

public MTRSettingsRecord()

MTRSettingsRecord

public MTRSettingsRecord(RecordInputStream in)

Method Detail

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

getGenericRecordType

public HSSFRecordTypes getGenericRecordType()

Specified by:

getGenericRecordType in interface GenericRecord

Specified by:

getGenericRecordType in class Record

getUserThreadCount

public int getUserThreadCount()

Returns count of calculation threads. Must between 1 ~ 0x400. If either fMTREnabled or fUserSeetThreadCount is false, ignore this value

Returns:

setUserThreadCount

public void setUserThreadCount(int count)

isMTREnabled

public boolean isMTREnabled()

Returns whether the multi-threaded calculation is enabled.

Returns:

isUserSetThreadCount

public boolean isUserSetThreadCount()

Returns whether the thread count was manually specified by the user.

Returns:

setMTREnabled

public void setMTREnabled(boolean flag)

setUserSetThreadCount

public void setUserSetThreadCount(boolean flag)

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

copy

public MTRSettingsRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class StandardRecord

Returns:

a deep copy of the implementing class / instance

clone

public Object clone()

Overrides:

clone in class Object

getDataSize

protected int getDataSize()

Specified by:

getDataSize in class StandardRecord

getGenericProperties

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