Package org.apache.poi.ss.formula
This package contains common internal POI code for manipulating formulas.
Client applications should not refer to these classes directly.
-
Interface Summary Interface Description EvaluationCell Abstracts a cell for the purpose of formula evaluation.EvaluationName Abstracts a name record for formula evaluation.EvaluationSheet Abstracts a sheet for the purpose of formula evaluation.EvaluationWorkbook Abstracts a workbook for the purpose of formula evaluation.ExternSheetReferenceToken Should be implemented by anyPtg
subclass that needs has an extern sheet index
For POI internal use onlyFormulaParsingWorkbook Abstracts a workbook for the purpose of formula parsing.
For POI internal use onlyFormulaRenderingWorkbook Abstracts a workbook for the purpose of converting formula to text.IStabilityClassifier Used to help optimise cell evaluation result caching by allowing applications to specify which parts of a workbook are final.
The term final is introduced here to denote immutability or 'having constant definition'.SheetRange ThreeDEval Optional Extension to the likes ofAreaEval
andAreaEvalBase
, which allows for looking up 3D (sheet+row+column) evaluationsTwoDEval Common interface ofAreaEval
andAreaEvalBase
, for 2D (row+column) evaluationsWorkbookDependentFormula Should be implemented by anyPtg
subclass that needs a workbook to render its formula.WorkbookEvaluatorProvider Provides access to aWorkbookEvaluator
, eg for use withCollaboratingWorkbooksEnvironment
-
Class Summary Class Description BaseFormulaEvaluator Common functionality across file formats for evaluating formula cells.CacheAreaEval Provides holding structure for temporary values in arrays during the evaluation process.CollaboratingWorkbooksEnvironment Manages a collection ofWorkbookEvaluator
s, in order to support evaluation of formulas across spreadsheets.ConditionalFormattingEvaluator Evaluates Conditional Formatting constraints.DataValidationEvaluator Evaluates Data Validation constraints.DataValidationEvaluator.DataValidationContext This class organizes and encapsulates all the pieces of information related to a single data validation configuration for a single cell.EvaluationConditionalFormatRule Abstracted and cached version of a Conditional Format rule for use with aConditionalFormattingEvaluator
.EvaluationWorkbook.ExternalName EvaluationWorkbook.ExternalSheet EvaluationWorkbook.ExternalSheetRange Formula Encapsulates an encoded formula token array.FormulaParser This class parses a formula string into a List of tokens in RPN order.FormulaRenderer Common logic for rendering formulas.FormulaShifter Updates Formulas as rows or sheets are shiftedLazyRefEval Provides Lazy Evaluation to a 3D ReferenceNameIdentifier OperationEvaluationContext Contains all the contextual information required to evaluate an operation within a formulaSharedFormula Encapsulates logic to convert shared formulaa into non shared equivalentSheetIdentifier SheetNameFormatter Formats sheet names for use in formula expressions.SheetRangeAndWorkbookIndexFormatter SheetRangeIdentifier WorkbookEvaluator Evaluates formula cells. -
Enum Summary Enum Description DataValidationEvaluator.OperatorEnum Not calling it OperatorType to avoid confusion for now with DataValidationConstraint.OperatorType.DataValidationEvaluator.ValidationEnum Not calling it ValidationType to avoid confusion for now with DataValidationConstraint.ValidationType.FormulaType Enumeration of various formula types. -
Exception Summary Exception Description CollaboratingWorkbooksEnvironment.WorkbookNotFoundException FormulaParseException This exception thrown when a supplied formula has incorrect syntax (or syntax currently not supported by POI).