Apache POI - Common 5.3.0 · org.apache.poi.ss.formula

Interface Summary

Modifier and Type	Interface and Description
public interface	EvaluationCell Abstracts a cell for the purpose of formula evaluation.
public interface	EvaluationName Abstracts a name record for formula evaluation.
public interface	EvaluationSheet Abstracts a sheet for the purpose of formula evaluation.
public interface	EvaluationWorkbook Abstracts a workbook for the purpose of formula evaluation.
public interface	ExternSheetReferenceToken Should be implemented by any `org.apache.poi.ss.formula.ptg.Ptg` subclass that needs has an extern sheet index For POI internal use only
public interface	FormulaParsingWorkbook Abstracts a workbook for the purpose of formula parsing.
public interface	FormulaRenderingWorkbook Abstracts a workbook for the purpose of converting formula to text.
pack-priv interface	IEvaluationListener Tests can implement this class to track the internal working of the `WorkbookEvaluator`.
public interface	IStabilityClassifier Used to help optimise cell evaluation result caching by allowing applications to specify which parts of a workbook are final.
public interface	SheetRange
public interface	ThreeDEval Optional Extension to the likes of `AreaEval` and `org.apache.poi.ss.formula.eval.AreaEvalBase`, which allows for looking up 3D (sheet+row+column) evaluations
public interface	TwoDEval Common interface of `AreaEval` and `org.apache.poi.ss.formula.eval.AreaEvalBase`, for 2D (row+column) evaluations
public interface	WorkbookDependentFormula Should be implemented by any `org.apache.poi.ss.formula.ptg.Ptg` subclass that needs a workbook to render its formula.
public interface	WorkbookEvaluatorProvider Provides access to a `WorkbookEvaluator`, eg for use with `CollaboratingWorkbooksEnvironment` For POI internal use only

Class Summary

Modifier and Type	Class and Description
public abstract class	BaseFormulaEvaluator Common functionality across file formats for evaluating formula cells.
public class	CacheAreaEval Provides holding structure for temporary values in arrays during the evaluation process.
pack-priv abstract class	CellCacheEntry Stores the parameters that identify the evaluation of one cell.
pack-priv class	CellEvaluationFrame Stores details about the current evaluation of a cell.
public class	CollaboratingWorkbooksEnvironment Manages a collection of `WorkbookEvaluator`s, in order to support evaluation of formulas across spreadsheets.
public class	ConditionalFormattingEvaluator Evaluates Conditional Formatting constraints.
public class	DataValidationEvaluator Evaluates Data Validation constraints.
pack-priv class	EvaluationCache Performance optimisation for `org.apache.poi.ss.usermodel.FormulaEvaluator`.
public class	EvaluationConditionalFormatRule Abstracted and cached version of a Conditional Format rule for use with a `ConditionalFormattingEvaluator`.
pack-priv class	EvaluationTracker Instances of this class keep track of multiple dependent cell evaluations due to recursive calls to `WorkbookEvaluator#evaluate(EvaluationCell)`} The main purpose of this class is to detect an attempt to evaluate a cell that is already being evaluated.
public class	Formula Encapsulates an encoded formula token array.
pack-priv class	FormulaCellCache
pack-priv class	FormulaCellCacheEntry Stores the cached result of a formula evaluation, along with the set of sensitive input cells
pack-priv class	FormulaCellCacheEntrySet A custom implementation of `java.util.HashSet` in order to reduce memory consumption.
public class	FormulaParseException This exception thrown when a supplied formula has incorrect syntax (or syntax currently not supported by POI).
public class	FormulaParser This class parses a formula string into a List of tokens in RPN order.
public class	FormulaRenderer Common logic for rendering formulas.
public class	FormulaShifter Updates Formulas as rows or sheets are shifted
pack-priv class	FormulaUsedBlankCellSet Optimization - compacts many blank cell references used by a single formula.
pack-priv class	LazyAreaEval Provides Lazy Evaluation to 3D Ranges
public class	LazyRefEval Provides Lazy Evaluation to a 3D Reference
public class	NameIdentifier
pack-priv class	OperandClassTransformer This class performs 'operand class' transformation.
public class	OperationEvaluationContext Contains all the contextual information required to evaluate an operation within a formula For POI internal use only
pack-priv class	OperationEvaluatorFactory This class creates `OperationEval` instances to help evaluate `OperationPtg` formula tokens.
pack-priv class	ParseNode Represents a syntactic element from a formula by encapsulating the corresponding `Ptg` token.
pack-priv class	PlainCellCache
pack-priv class	PlainValueCellCacheEntry Used for non-formula cells, primarily to keep track of the referencing (formula) cells.
public class	SharedFormula Encapsulates logic to convert shared formula into non shared equivalent
public class	SheetIdentifier
public class	SheetNameFormatter Formats sheet names for use in formula expressions.
public class	SheetRangeAndWorkbookIndexFormatter
pack-priv class	SheetRangeEvaluator Evaluator for returning cells or sheets for a range of sheets
public class	SheetRangeIdentifier
pack-priv class	SheetRefEvaluator Evaluator for cells within a specific Sheet
pack-priv class	UserDefinedFunction Common entry point for all user-defined (non-built-in) functions (where `AbstractFunctionPtg.field_2_fnc_index` == 255)
public class	WorkbookEvaluator Evaluates formula cells.

Modifier and Type	Enum and Description
public enum	FormulaType Enumeration of various formula types.
pack-priv enum	OperatorEnum Not calling it OperatorType to avoid confusion for now with other classes.

Package org.apache.poi.ss.formula

Interface Summary

Class Summary

Enum Summary