Class FormulaRecord

    • 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

        @Deprecated
        @Removal(version="6.0.0")
        public int getCachedResultType()
        Deprecated.
        POI 5.0.0, will be removed in 6.0, use getCachedResultTypeEnum until switch to enum is fully done
        Returns:
        The type of the cached value or CellType.NUMERIC.getCode() if the cached value is empty
      • getCachedResultTypeEnum

        public CellType getCachedResultTypeEnum()
        Returns the type of the cached result
        Returns:
        The type of the cached value or CellType.NUMERIC if the cached value is empty
        Since:
        POI 5.0.0
      • 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
      • getValueDataSize

        protected int getValueDataSize()
        Specified by:
        getValueDataSize in class CellRecord
        Returns:
        the size (in bytes) of the value data for this cell record