org.apache.poi.hssf.record

Class IterationRecord

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

All Implemented Interfaces:

Duplicatable

public final class IterationRecord
extends StandardRecord

Tells whether to iterate over formula calculations or not. If a formula is dependent upon another formula's result. (odd feature for something that can only have 32 elements in a formula!)

Field Summary

Fields

Modifier and Type	Field and Description
static short	sid

Constructor Summary

Constructors

Constructor and Description
IterationRecord(boolean iterateOn)
IterationRecord(IterationRecord other)
IterationRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
IterationRecord	clone() Deprecated.
IterationRecord	copy()
protected int	getDataSize()
boolean	getIteration() get whether or not to iterate for calculations
short	getSid() return the non static version of the id for this record.
void	serialize(LittleEndianOutput out) Write the data content of this BIFF record.
void	setIteration(boolean iterate) set whether or not to iterate for calculations
java.lang.String	toString() get a string representation of the record (for biffview/debugging)

Methods inherited from class org.apache.poi.hssf.record.StandardRecord

getRecordSize, serialize

Methods inherited from class org.apache.poi.hssf.record.Record

cloneViaReserialise, serialize

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sid

public static final short sid

See Also:

Constant Field Values

Constructor Detail

IterationRecord

public IterationRecord(IterationRecord other)

IterationRecord

public IterationRecord(boolean iterateOn)

IterationRecord

public IterationRecord(RecordInputStream in)

Method Detail

setIteration

public void setIteration(boolean iterate)

set whether or not to iterate for calculations

Parameters:

iterate - or not

getIteration

public boolean getIteration()

get whether or not to iterate for calculations

Returns:

whether iterative calculations are turned off or on

toString

public java.lang.String toString()

Description copied from class: Record

get a string representation of the record (for biffview/debugging)

Overrides:

toString in class Record

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

getDataSize

protected int getDataSize()

Specified by:

getDataSize in class StandardRecord

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

clone

@Deprecated
 @Removal(version="5.0.0")
public IterationRecord clone()

Deprecated.

Overrides:

clone in class java.lang.Object

copy

public IterationRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class StandardRecord

Returns:

a deep copy of the implementing class / instance