Package org.apache.poi.ss.formula

This package contains common internal POI code for manipulating formulas.

See: Description

Interface Summary

Interface	Description
EvaluationCell	Abstracts a cell for the purpose of formula evaluation.
EvaluationConditionalFormatRule.ValueFunction	instances evaluate the values for a region and return the positive matches for the function type.
EvaluationName	Abstracts a name record for formula evaluation. For POI internal use only
EvaluationSheet	Abstracts a sheet for the purpose of formula evaluation. For POI internal use only
EvaluationWorkbook	Abstracts a workbook for the purpose of formula evaluation. For POI internal use only
ExternSheetReferenceToken	Should be implemented by any Ptg subclass that needs has an extern sheet index For POI internal use only
FormulaParsingWorkbook	Abstracts a workbook for the purpose of formula parsing. For POI internal use only
FormulaRenderingWorkbook	Abstracts a workbook for the purpose of converting formula to text. For POI internal use only
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 of AreaEval and AreaEvalBase, which allows for looking up 3D (sheet+row+column) evaluations
TwoDEval	Common interface of AreaEval and AreaEvalBase, for 2D (row+column) evaluations
WorkbookDependentFormula	Should be implemented by any Ptg subclass that needs a workbook to render its formula.
WorkbookEvaluatorProvider	Provides access to a WorkbookEvaluator, eg for use with CollaboratingWorkbooksEnvironment

Class Summary

Class	Description
BaseFormulaEvaluator	Common functionality across file formats for evaluating formula cells.
CacheAreaEval
CollaboratingWorkbooksEnvironment	Manages a collection of WorkbookEvaluators, 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 a ConditionalFormattingEvaluator.
EvaluationConditionalFormatRule.ValueAndFormat	Note: this class has a natural ordering that is inconsistent with equals.
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. For POI internal use only
FormulaShifter	Updates Formulas as rows or sheets are shifted
LazyRefEval	Provides Lazy Evaluation to a 3D Reference
NameIdentifier
OperationEvaluationContext	Contains all the contextual information required to evaluate an operation within a formula For POI internal use only
SharedFormula	Encapsulates logic to convert shared formulaa into non shared equivalent
SheetIdentifier
SheetNameFormatter	Formats sheet names for use in formula expressions.
SheetRangeAndWorkbookIndexFormatter
SheetRangeIdentifier
WorkbookEvaluator	Evaluates formula cells. For performance reasons, this class keeps a cache of all previously calculated intermediate cell values.

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.
EvaluationConditionalFormatRule.OperatorEnum	Not calling it OperatorType to avoid confusion for now with other classes.
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).

Package org.apache.poi.ss.formula Description

This package contains common internal POI code for manipulating formulas. Client applications should not refer to these classes directly.