FormulaRecord (Bio-Formats API)

java.lang.Object
- loci.poi.hssf.record.Record
- - loci.poi.hssf.record.FormulaRecord

All Implemented Interfaces:

Comparable, CellValueRecordInterface
```
public class FormulaRecord
extends Record
implements CellValueRecordInterface, Comparable
```
Formula Record. REFERENCE: PG 317/444 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Version:

2.0-pre

Author:

Andrew C. Oliver (acoliver at apache dot org), Jason Height (jheight at chariot dot net dot au)

Field Summary

Fields
Modifier and Type	Field and Description
`private byte[]`	`all_data`
`private BitField`	`alwaysCalc`
`private BitField`	`calcOnLoad`
`private int`	`field_1_row`
`private short`	`field_2_column`
`private short`	`field_3_xf`
`private double`	`field_4_value`
`private short`	`field_5_options`
`private int`	`field_6_zero`
`private short`	`field_7_expression_len`
`private Stack`	`field_8_parsed_expr`
`private BitField`	`sharedFormula`
`static short`	`sid`
`private byte[]`	`value_data` Since the NaN support seems sketchy (different constants) we'll store and spit it out directly

Constructor Summary

Constructors
Constructor and Description

FormulaRecord()
Creates new FormulaRecord

FormulaRecord(RecordInputStream in)
Constructs a Formula record and sets its fields appropriately.

Constructors
Constructor and Description
`FormulaRecord()` Creates new FormulaRecord
`FormulaRecord(RecordInputStream in)` Constructs a Formula record and sets its fields appropriately.

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`int`	`compareTo(Object obj)`
`boolean`	`equals(Object obj)`
`protected void`	`fillFields(RecordInputStream in)` called by the constructor, should set class level fields.
`short`	`getColumn()` get the column this cell defines within the row
`short`	`getExpressionLength()` get the length (in number of tokens) of the expression
`int`	`getNumberOfExpressionTokens()` get the size of the stack
`short`	`getOptions()` get the option flags
`List`	`getParsedExpression()` get the stack as a list
`int`	`getRecordSize()` gives the current serialized size of the record.
`int`	`getRow()` get the row this cell occurs on
`short`	`getSid()` return the non static version of the id for this record.
`private int`	`getTotalPtgSize()`
`double`	`getValue()` get the calculated value of the formula
`short`	`getXFIndex()`
`boolean`	`isAfter(CellValueRecordInterface i)` returns whether this cell is after the passed in cell
`boolean`	`isBefore(CellValueRecordInterface i)` returns whether this cell is before the passed in cell
`boolean`	`isEqual(CellValueRecordInterface i)` returns whether this cell represents the same cell (NOT VALUE)
`boolean`	`isInValueSection()` DBCELL, ROW, VALUES all say yes
`boolean`	`isSharedFormula()`
`boolean`	`isValue()` tells whether this type of record contains a value
`Ptg`	`peekExpressionToken()` peek at the token on the top of stack
`Ptg`	`popExpressionToken()` pop a token off of the stack
`void`	`pushExpressionToken(Ptg ptg)` push a token onto the stack
`int`	`serialize(int offset, byte[] data)` called by the class that is responsible for writing this sucker.
`void`	`setColumn(short column)` set the column this cell defines within the row
`void`	`setExpressionLength(short len)` set the length (in number of tokens) of the expression
`void`	`setOptions(short options)` set the option flags
`void`	`setParsedExpression(Stack ptgs)`
`void`	`setRow(int row)` set the row this cell occurs on
`void`	`setSharedFormula(boolean flag)`
`void`	`setValue(double value)` set the calculated value of the formula
`void`	`setXFIndex(short xf)`
`String`	`toString()` get a string representation of the record (for biffview/debugging)
`protected void`	`validateSid(short id)` called by constructor, should throw runtime exception in the event of a record passed with a differing ID.

Methods inherited from class loci.poi.hssf.record.Record
serialize

Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - sid
```
public static final short sid
```
    See Also:
    Constant Field Values
  - field_1_row
```
private int field_1_row
```
  - field_2_column
```
private short field_2_column
```
  - field_3_xf
```
private short field_3_xf
```
  - field_4_value
```
private double field_4_value
```
  - field_5_options
```
private short field_5_options
```
  - alwaysCalc
```
private BitField alwaysCalc
```
  - calcOnLoad
```
private BitField calcOnLoad
```
  - sharedFormula
```
private BitField sharedFormula
```
  - field_6_zero
```
private int field_6_zero
```
  - field_7_expression_len
```
private short field_7_expression_len
```
  - field_8_parsed_expr
```
private Stack field_8_parsed_expr
```
  - value_data
```
private byte[] value_data
```
    Since the NaN support seems sketchy (different constants) we'll store and spit it out directly
  - all_data
```
private byte[] all_data
```
- Constructor Detail
  - FormulaRecord
```
public FormulaRecord()
```
    Creates new FormulaRecord
  - FormulaRecord
```
public FormulaRecord(RecordInputStream in)
```
    Constructs a Formula record and sets its fields appropriately. Note - id must be 0x06 (NOT 0x406 see MSKB #Q184647 for an "explanation of this bug in the documentation) or an exception will be throw upon validation
    
    Parameters:
    in - the RecordInputstream to read the record from
- Method Detail
  - fillFields
```
protected void fillFields(RecordInputStream in)
```
    Description copied from class: Record
    
    called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.
    
    Specified by:
    
    fillFields in class Record
    
    Parameters:
    in - the RecordInputstream to read the record from
  - setRow
```
public void setRow(int row)
```
    Description copied from interface: CellValueRecordInterface
    
    set the row this cell occurs on
    
    Specified by:
    
    setRow in interface CellValueRecordInterface
    
    Parameters:
    row - the row this cell occurs within
  - setColumn
```
public void setColumn(short column)
```
    Description copied from interface: CellValueRecordInterface
    
    set the column this cell defines within the row
    
    Specified by:
    
    setColumn in interface CellValueRecordInterface
    
    Parameters:
    column - the column this cell defines
  - setXFIndex
```
public void setXFIndex(short xf)
```
    Specified by:
    
    setXFIndex in interface CellValueRecordInterface
  - setValue
```
public void setValue(double value)
```
    set the calculated value of the formula
    
    Parameters:
    value - calculated value
  - setOptions
```
public void setOptions(short options)
```
    set the option flags
    
    Parameters:
    options - bitmask
  - setExpressionLength
```
public void setExpressionLength(short len)
```
    set the length (in number of tokens) of the expression
    
    Parameters:
    len - length
  - getRow
```
public int getRow()
```
    Description copied from interface: CellValueRecordInterface
    
    get the row this cell occurs on
    
    Specified by:
    
    getRow in interface CellValueRecordInterface
    
    Returns:
    the row
  - getColumn
```
public short getColumn()
```
    Description copied from interface: CellValueRecordInterface
    
    get the column this cell defines within the row
    
    Specified by:
    
    getColumn in interface CellValueRecordInterface
    
    Returns:
    the column
  - getXFIndex
```
public short getXFIndex()
```
    Specified by:
    
    getXFIndex in interface CellValueRecordInterface
  - getValue
```
public double getValue()
```
    get the calculated value of the formula
    
    Returns:
    calculated value
  - getOptions
```
public short getOptions()
```
    get the option flags
    
    Returns:
    bitmask
  - isSharedFormula
```
public boolean isSharedFormula()
```
  - setSharedFormula
```
public void setSharedFormula(boolean flag)
```
  - getExpressionLength
```
public short getExpressionLength()
```
    get the length (in number of tokens) of the expression
    
    Returns:
    expression length
  - pushExpressionToken
```
public void pushExpressionToken(Ptg ptg)
```
    push a token onto the stack
    
    Parameters:
    ptg - the token
  - popExpressionToken
```
public Ptg popExpressionToken()
```
    pop a token off of the stack
    
    Returns:
    Ptg - the token
  - peekExpressionToken
```
public Ptg peekExpressionToken()
```
    peek at the token on the top of stack
    
    Returns:
    Ptg - the token
  - getNumberOfExpressionTokens
```
public int getNumberOfExpressionTokens()
```
    get the size of the stack
    
    Returns:
    size of the stack
  - getParsedExpression
```
public List getParsedExpression()
```
    get the stack as a list
    
    Returns:
    list of tokens (casts stack to a list and returns it!) this method can return null is we are unable to create Ptgs from existing excel file callers should check for null!
  - setParsedExpression
```
public void setParsedExpression(Stack ptgs)
```
  - validateSid
```
protected void validateSid(short id)
```
    called by constructor, should throw runtime exception in the event of a record passed with a differing ID.
    
    Specified by:
    
    validateSid in class Record
    
    Parameters:
    id - alleged id for this record
  - 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
  - serialize
```
public int serialize(int offset,
            byte[] data)
```
    called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.
    
    Specified by:
    
    serialize in class Record
    
    Parameters:
    offset - to begin writing at
    data - byte array containing instance data
    
    Returns:
    byte array containing instance data
  - getRecordSize
```
public int getRecordSize()
```
    Description copied from class: Record
    
    gives the current serialized size of the record. Should include the sid and reclength (4 bytes).
    
    Overrides:
    
    getRecordSize in class Record
  - getTotalPtgSize
```
private int getTotalPtgSize()
```
  - isBefore
```
public boolean isBefore(CellValueRecordInterface i)
```
    Description copied from interface: CellValueRecordInterface
    
    returns whether this cell is before the passed in cell
    
    Specified by:
    
    isBefore in interface CellValueRecordInterface
    
    Parameters:
    i - another cell interface record to compare
    
    Returns:
    true if the cells is before, or false if not
  - isAfter
```
public boolean isAfter(CellValueRecordInterface i)
```
    Description copied from interface: CellValueRecordInterface
    
    returns whether this cell is after the passed in cell
    
    Specified by:
    
    isAfter in interface CellValueRecordInterface
    
    Parameters:
    i - record to compare
    
    Returns:
    true if the cell is after, false if not
  - isEqual
```
public boolean isEqual(CellValueRecordInterface i)
```
    Description copied from interface: CellValueRecordInterface
    
    returns whether this cell represents the same cell (NOT VALUE)
    
    Specified by:
    
    isEqual in interface CellValueRecordInterface
    
    Parameters:
    i - record to compare
    
    Returns:
    true if the cells are the same cell (positionally), false if not.
  - isInValueSection
```
public boolean isInValueSection()
```
    Description copied from class: Record
    
    DBCELL, ROW, VALUES all say yes
    
    Overrides:
    
    isInValueSection in class Record
  - isValue
```
public boolean isValue()
```
    Description copied from class: Record
    
    tells whether this type of record contains a value
    
    Overrides:
    
    isValue in class Record
  - compareTo
```
public int compareTo(Object obj)
```
    Specified by:
    
    compareTo in interface Comparable
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Description copied from class: Record
    
    get a string representation of the record (for biffview/debugging)
    
    Overrides:
    
    toString in class Record
  - clone
```
public Object clone()
```
    Specified by:
    
    clone in interface CellValueRecordInterface
    
    Overrides:
    
    clone in class Record

Class FormulaRecord

Field Summary

Constructor Summary

Method Summary

Methods inherited from class loci.poi.hssf.record.Record

Methods inherited from class java.lang.Object

Field Detail

sid

field_1_row

field_2_column

field_3_xf

field_4_value

field_5_options

alwaysCalc

calcOnLoad

sharedFormula

field_6_zero

field_7_expression_len

field_8_parsed_expr

value_data

all_data

Constructor Detail

FormulaRecord

FormulaRecord

Method Detail

fillFields

setRow

setColumn

setXFIndex

setValue

setOptions

setExpressionLength

getRow

getColumn

getXFIndex

getValue

getOptions

isSharedFormula

setSharedFormula

getExpressionLength

pushExpressionToken

popExpressionToken

peekExpressionToken

getNumberOfExpressionTokens

getParsedExpression

setParsedExpression

validateSid

getSid

serialize

getRecordSize

getTotalPtgSize

isBefore

isAfter

isEqual

isInValueSection

isValue

compareTo

equals

toString

clone