Package org.apache.poi.hssf.record

Class FormulaRecord

  • All Implemented Interfaces:
    java.lang.Cloneable, CellValueRecordInterface
    public final class FormulaRecord
extends CellRecord
implements java.lang.Cloneable
    Formula Record (0x0006). REFERENCE: PG 317/444 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

    • Constructor Detail

      • FormulaRecord

        public FormulaRecord()
        Creates new FormulaRecord

    • Method Detail

      • setValue

        public void setValue​(double value)
        set the calculated value of the formula
        Parameters:
        value - calculated value

      • setCachedResultTypeEmptyString

        public void setCachedResultTypeEmptyString()

      • setCachedResultTypeString

        public void setCachedResultTypeString()

      • setCachedResultErrorCode

        public void setCachedResultErrorCode​(int errorCode)

      • setCachedResultBoolean

        public void setCachedResultBoolean​(boolean value)

      • hasCachedResultString

        public boolean hasCachedResultString()
        Returns:
        true if this FormulaRecord is followed by a StringRecord representing the cached text result of the formula evaluation.

      • getCachedResultType

        public int getCachedResultType()

      • getCachedBooleanValue

        public boolean getCachedBooleanValue()

      • getCachedErrorValue

        public int getCachedErrorValue()

      • setOptions

        public void setOptions​(short options)
        set the option flags
        Parameters:
        options - bitmask

      • 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)

      • isAlwaysCalc

        public boolean isAlwaysCalc()

      • setAlwaysCalc

        public void setAlwaysCalc​(boolean flag)

      • isCalcOnLoad

        public boolean isCalcOnLoad()

      • setCalcOnLoad

        public void setCalcOnLoad​(boolean flag)

      • getParsedExpression

        public Ptg[] getParsedExpression()
        Returns:
        the formula tokens. never null

      • getFormula

        public Formula getFormula()

      • setParsedExpression

        public void setParsedExpression​(Ptg[] ptgs)

      • 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