Package org.apache.poi.hssf.record

Class FormulaRecord

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.CellRecord
org.apache.poi.hssf.record.FormulaRecord
All Implemented Interfaces:
org.apache.poi.common.Duplicatable, GenericRecord, CellValueRecordInterface
public final class FormulaRecord extends CellRecord
Formula Record (0x0006).

  • Field Details

  • Constructor Details

    • FormulaRecord

      public FormulaRecord()
      Creates new FormulaRecord

    • FormulaRecord

      public FormulaRecord(FormulaRecord other)

    • FormulaRecord

      public FormulaRecord(RecordInputStream ris)

  • Method Details

    • 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

    • copy

      public FormulaRecord copy()
      Specified by:
      copy in interface org.apache.poi.common.Duplicatable
      Specified by:
      copy in class CellRecord

    • getGenericRecordType

      public HSSFRecordTypes getGenericRecordType()
      Specified by:
      getGenericRecordType in interface GenericRecord
      Specified by:
      getGenericRecordType in class Record

    • getGenericProperties

      public Map<String,Supplier<?>> getGenericProperties()
      Specified by:
      getGenericProperties in interface GenericRecord
      Overrides:
      getGenericProperties in class CellRecord