Package | Description |
---|---|
org.zkoss.poi.hssf.model |
Provides low level API structures for reading, writing, modifying XLS files.
|
org.zkoss.poi.hssf.record |
Record package contains class representations for XLS binary strutures.
|
org.zkoss.poi.hssf.record.aggregates |
record aggregates are not real "records" but collections of records that act as a single record.
|
org.zkoss.poi.hssf.record.chart | |
org.zkoss.poi.hssf.usermodel |
usermodel package maps HSSF low level strutures to familiar workbook/sheet model
Related Documentation
For overviews, tutorials, examples, guides, and tool documentation, please see:
Apache POI Project
|
org.zkoss.poi.ss.formula |
This package contains common internal POI code for manipulating formulas.
|
org.zkoss.poi.ss.formula.eval | |
org.zkoss.poi.ss.formula.ptg |
formula package contains binary PTG structures used in Formulas
Related Documentation
For overviews, tutorials, examples, guides, and tool documentation, please see:
Apache POI Project
|
org.zkoss.poi.xssf.usermodel | |
org.zkoss.zss.model.impl.sys.formula |
ZK Spreadsheet Internal Book Model Implementation classes.
|
org.zkoss.zss.model.sys.formula |
ZK Spreadsheet Internal Book Model Engines classes.
|
org.zkoss.zssex.formula |
Classes bridging ZK Spreadsheet formula functions to ZK EL functions.
|
Modifier and Type | Method and Description |
---|---|
static Ptg[] |
HSSFFormulaParser.parse(java.lang.String formula,
HSSFWorkbook workbook)
Convenience method for parsing cell formulas. see
HSSFFormulaParser.parse(String, HSSFWorkbook, int, int) |
static Ptg[] |
HSSFFormulaParser.parse(java.lang.String formula,
HSSFWorkbook workbook,
int formulaType) |
static Ptg[] |
HSSFFormulaParser.parse(java.lang.String formula,
HSSFWorkbook workbook,
int formulaType,
int sheetIndex) |
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
HSSFFormulaParser.toFormulaString(HSSFWorkbook book,
Ptg[] ptgs)
Static method to convert an array of
Ptg s in RPN order
to a human readable string format in infix mode. |
Modifier and Type | Method and Description |
---|---|
Ptg |
LbsDataSubRecord.getFormula() |
Ptg[] |
DVRecord.getFormula1() |
Ptg[] |
DVRecord.getFormula2() |
Ptg[] |
ArrayRecord.getFormulaTokens() |
Ptg[] |
SharedFormulaRecord.getFormulaTokens(FormulaRecord formula) |
Ptg |
TextObjectRecord.getLinkRefPtg() |
Ptg[] |
NameRecord.getNameDefinition()
gets the definition, reference (Formula)
|
Ptg[] |
FormulaRecord.getParsedExpression() |
Ptg[] |
ExternalNameRecord.getParsedExpression() |
Ptg[] |
CFRuleRecord.getParsedExpression1()
get the stack of the 1st expression as a list
|
Ptg[] |
CFRuleRecord.getParsedExpression2()
get the stack of the 2nd expression as a list
|
Modifier and Type | Method and Description |
---|---|
void |
NameRecord.setNameDefinition(Ptg[] ptgs) |
void |
FormulaRecord.setParsedExpression(Ptg[] ptgs) |
void |
ExternalNameRecord.setParsedExpression(Ptg[] ptgs) |
void |
CFRuleRecord.setParsedExpression1(Ptg[] ptgs) |
void |
CFRuleRecord.setParsedExpression2(Ptg[] ptgs) |
Constructor and Description |
---|
DVRecord(int validationType,
int operator,
int errorStyle,
boolean emptyCellAllowed,
boolean suppressDropDownArrow,
boolean isExplicitList,
boolean showPromptBox,
java.lang.String promptTitle,
java.lang.String promptText,
boolean showErrorBox,
java.lang.String errorTitle,
java.lang.String errorText,
Ptg[] formula1,
Ptg[] formula2,
CellRangeAddressList regions) |
DVRecord(int validationType,
int operator,
int errorStyle,
boolean emptyCellAllowed,
boolean suppressDropDownArrow,
boolean isExplicitList,
boolean showPromptBox,
java.lang.String promptTitle,
java.lang.String promptText,
boolean showErrorBox,
java.lang.String errorTitle,
java.lang.String errorText,
Ptg[] formula1,
Ptg[] formula2,
CellRangeAddressList regions) |
Modifier and Type | Method and Description |
---|---|
Ptg[] |
FormulaRecordAggregate.getFormulaTokens() |
Modifier and Type | Method and Description |
---|---|
void |
FormulaRecordAggregate.setArrayFormula(CellRangeAddress r,
Ptg[] ptgs) |
void |
FormulaRecordAggregate.setParsedExpression(Ptg[] ptgs)
Also checks for a related shared formula and unlinks it if found
|
Modifier and Type | Method and Description |
---|---|
Ptg[] |
LinkedDataRecord.getFormulaOfLink()
Get the formula of link field for the LinkedData record.
|
Modifier and Type | Method and Description |
---|---|
void |
LinkedDataRecord.setFormulaOfLink(Ptg[] ptgs)
Set the formula of link field for the LinkedData record.
|
Modifier and Type | Method and Description |
---|---|
Ptg[] |
DVConstraint.FormulaPair.getFormula1() |
Ptg[] |
DVConstraint.FormulaPair.getFormula2() |
Ptg[] |
HSSFEvaluationWorkbook.getFormulaTokens(EvaluationCell evalCell) |
Ptg[] |
HSSFEvaluationWorkbook.getFormulaTokens(int sheetIndex,
java.lang.String formula) |
Constructor and Description |
---|
FormulaPair(Ptg[] formula1,
Ptg[] formula2) |
FormulaPair(Ptg[] formula1,
Ptg[] formula2) |
Modifier and Type | Method and Description |
---|---|
Ptg[] |
SharedFormula.convertSharedFormulas(Ptg[] ptgs,
int formulaRow,
int formulaColumn)
Creates a non shared formula from the shared formula counterpart, i.e.
|
static Ptg |
PtgShifter.createDeletedRef(Ptg ptg) |
static Ptg |
PtgShifter.createDeletedRef3d(java.lang.String bookName,
Ptg ptg) |
Ptg[] |
EvaluationWorkbook.getFormulaTokens(EvaluationCell cell) |
Ptg[] |
EvaluationWorkbook.getFormulaTokens(int sheetIndex,
java.lang.String formula) |
Ptg[] |
EvaluationName.getNameDefinition() |
Ptg[] |
Formula.getTokens() |
static Ptg[] |
Formula.getTokens(Formula formula)
|
static Ptg[] |
FormulaParser.parse(java.lang.String formula,
FormulaParsingWorkbook workbook,
int formulaType,
int sheetIndex)
Parse a formula into a array of tokens
|
static Ptg[] |
FormulaParser.parse(java.lang.String formula,
FormulaParsingWorkbook workbook,
int formulaType,
int sheetIndex,
int rowIdx,
int colIdx)
Parse a formula into a array of tokens
|
static Ptg[] |
FormulaParser.parse(java.lang.String formula,
FormulaParsingWorkbook workbook,
int formulaType,
int sheetIndex,
java.util.Locale locale) |
static Ptg[] |
FormulaParser.parse(java.lang.String formula,
FormulaParsingWorkbook workbook,
int formulaType,
int sheetIndex,
java.util.Locale locale,
int rowIdx,
int colIdx) |
static Ptg[][] |
FormulaRenderer.unwrapPtgArrays(Ptg[] ptgs)
Static method to convert an RPN ptgs in the form of (areaPtg1, areaPtg2, ...) to Ptg[][].
|
Modifier and Type | Method and Description |
---|---|
void |
DependencyTracker.addDependency(OperationEvaluationContext ec,
Ptg[] ptgs)
Construct formula reference dependencies.
|
boolean |
PtgShifter.adjustFormula(Ptg[] ptgs,
int currentExternSheetIx) |
boolean |
FormulaShifter.adjustFormula(Ptg[] ptgs,
int currentExternSheetIx) |
Ptg[] |
SharedFormula.convertSharedFormulas(Ptg[] ptgs,
int formulaRow,
int formulaColumn)
Creates a non shared formula from the shared formula counterpart, i.e.
|
static Formula |
Formula.create(Ptg[] ptgs)
|
static Ptg |
PtgShifter.createDeletedRef(Ptg ptg) |
static Ptg |
PtgShifter.createDeletedRef3d(java.lang.String bookName,
Ptg ptg) |
ValueEval |
WorkbookEvaluator.evaluatePtgs(int sheetIndex,
Ptg[] tokens,
boolean ignoreDereference,
java.lang.Object ref) |
ValueEval |
WorkbookEvaluator.evaluatePtgs(int sheetIndex,
Ptg[] tokens,
boolean ignoreDereference,
java.lang.Object ref,
int[] offset) |
static java.lang.String |
FormulaRenderer.toFormulaCopyText(FormulaRenderingWorkbook book,
Ptg[] tokens,
java.lang.String formula) |
static java.lang.String |
FormulaRenderer.toFormulaEditText(FormulaRenderingWorkbook book,
Ptg[] tokens,
java.lang.String formula) |
static java.lang.String |
FormulaRenderer.toFormulaString(FormulaRenderingWorkbook book,
Ptg[] ptgs)
Static method to convert an array of
Ptg s in RPN order
to a human readable string format in infix mode. |
static java.lang.String |
FormulaRenderer.toInternalFormulaString(FormulaRenderingWorkbook book,
Ptg[] ptgs)
Static method to convert an array of
Ptg s in RPN order
to internal string format for storing into file. |
static Ptg[][] |
FormulaRenderer.unwrapPtgArrays(Ptg[] ptgs)
Static method to convert an RPN ptgs in the form of (areaPtg1, areaPtg2, ...) to Ptg[][].
|
Constructor and Description |
---|
NumberEval(Ptg ptg) |
StringEval(Ptg ptg) |
Modifier and Type | Class and Description |
---|---|
class |
AbstractFunctionPtg
This class provides the base functionality for Excel sheet functions
There are two kinds of function Ptgs - tFunc and tFuncVar
Therefore, this class will have ONLY two subclasses
|
class |
AddPtg
Addition operator PTG the "+" binomial operator.
|
class |
Area2DPtgBase
Common superclass of 2-D area refs
|
class |
Area3DPtg
Title: Area 3D Ptg - 3D reference (Sheet + Area)
Description: Defined a area in Extern Sheet.
|
class |
AreaErrPtg
AreaErr - handles deleted cell area references.
|
class |
AreaNPtg
Specifies a rectangular area of cells A1:A4 for instance.
|
class |
AreaPtg
Specifies a rectangular area of cells A1:A4 for instance.
|
class |
AreaPtgBase
Specifies a rectangular area of cells A1:A4 for instance.
|
class |
ArrayPtg
ArrayPtg - handles arrays
The ArrayPtg is a little weird, the size of the Ptg when parsing initially only
includes the Ptg sid and the reserved bytes.
|
class |
AttrPtg
"Special Attributes"
This seems to be a Misc Stuff and Junk record.
|
class |
BoolPtg
Boolean (boolean) Stores a (java) boolean value in a formula.
|
class |
ConcatPtg |
class |
ControlPtg
Common superclass for
tExp
tTbl
tParen
tNlr
tAttr
tSheet
tEndSheet
|
class |
DeferredNamePtg
A defined name is only used for parsing and evaluation which will not be written out.
|
class |
DeletedArea3DPtg
Title: Deleted Area 3D Ptg - 3D referecnce (Sheet + Area)
Description: Defined a area in Extern Sheet.
|
class |
DeletedRef3DPtg
Title: Deleted Reference 3D Ptg
Description: Defined a cell in extern sheet.
|
class |
DividePtg
This PTG implements the standard binomial divide "/"
|
class |
EqualPtg |
class |
ErrPtg |
class |
ExpPtg |
class |
FuncPtg |
class |
FuncVarPtg |
class |
GreaterEqualPtg
PTG class to implement greater or equal to
|
class |
GreaterThanPtg
Greater than operator PTG ">"
|
class |
IntersectionPtg |
class |
IntPtg
Integer (unsigned short integer) Stores an unsigned short value (java int) in
a formula
|
class |
LessEqualPtg
Ptg class to implement less than or equal
|
class |
LessThanPtg
Less than operator PTG "<".
|
class |
MemAreaPtg |
class |
MemErrPtg |
class |
MemFuncPtg |
class |
MissingArgPtg
Missing Function Arguments
Avik Sengupta <avik at apache.org>
|
class |
MultiplyPtg
Implements the standard mathmatical multiplication - *
|
class |
NamePtg |
class |
NameXPtg |
class |
NotEqualPtg
Ptg class to implement not equal
|
class |
NumberPtg
Number Stores a floating point value in a formula value stored in a 8 byte
field using IEEE notation
|
class |
OperandPtg |
class |
OperationPtg
defines a Ptg that is an operation instead of an operand
|
class |
Parenthesis2Ptg
This Ptg is for multiple area expression generally used in chart series and is only used for parsing
and evaluation which will not be written out.
|
class |
ParenthesisPtg
While formula tokens are stored in RPN order and thus do not need parenthesis
for precedence reasons, Parenthesis tokens ARE written to ensure that user
entered parenthesis are displayed as-is on reading back
Avik Sengupta <lists@aviksengupta.com> Andrew C.
|
class |
PercentPtg
Percent PTG.
|
class |
PowerPtg |
class |
RangePtg |
class |
Ref3DPtg
Title: Reference 3D Ptg
Description: Defined a cell in extern sheet.
|
class |
RefErrorPtg
RefError - handles deleted cell reference
|
class |
RefNPtg
RefNPtg
|
class |
RefPtg
ReferencePtg - handles references (such as A1, A2, IA4)
|
class |
RefPtgBase
ReferencePtgBase - handles references (such as A1, A2, IA4)
|
class |
ScalarConstantPtg
Common superclass of all
Ptg s that represent simple constant values. |
class |
StringPtg
String Stores a String value in a formula value stored in the format
<length 2 bytes>char[]
|
class |
SubtractPtg |
class |
TablePtg
TODO: XSSF only
|
class |
TblPtg
This ptg indicates a data table.
|
class |
UnaryMinusPtg
Unary Plus operator
does not have any effect on the operand
|
class |
UnaryPlusPtg
Unary Plus operator
does not have any effect on the operand
|
class |
UnionPtg |
class |
UnknownPtg |
class |
ValueOperatorPtg
Common superclass of all value operators.
|
Modifier and Type | Field and Description |
---|---|
static Ptg[] |
Ptg.EMPTY_PTG_ARRAY |
static Ptg |
MissingArgPtg.instance |
Modifier and Type | Method and Description |
---|---|
static Ptg |
Ptg.createPtg(LittleEndianInput in) |
static Ptg[] |
Ptg.readTokens(int size,
LittleEndianInput in)
Reads size bytes of the input stream, to create an array of Ptgs.
|
Modifier and Type | Method and Description |
---|---|
static boolean |
Ptg.doesFormulaReferToDeletedCell(Ptg[] ptgs) |
static int |
Ptg.getEncodedSize(Ptg[] ptgs)
This method will return the same result as
getEncodedSizeWithoutArrayData(Ptg[])
if there are no array tokens present. |
static int |
Ptg.getEncodedSizeWithoutArrayData(Ptg[] ptgs)
Used to calculate value that should be encoded at the start of the encoded Ptg token array;
|
static int |
Ptg.serializePtgs(Ptg[] ptgs,
byte[] array,
int offset)
Writes the ptgs to the data buffer, starting at the specified offset.
|
Modifier and Type | Method and Description |
---|---|
Ptg[] |
XSSFEvaluationWorkbook.getFormulaTokens(EvaluationCell evalCell) |
Ptg[] |
XSSFEvaluationWorkbook.getFormulaTokens(int sheetIndex,
java.lang.String formula) |
Modifier and Type | Method and Description |
---|---|
Ptg[] |
EvalBook.getFormulaTokens(EvaluationCell cell) |
Ptg[] |
EvalBook.getFormulaTokens(int sheetIndex,
java.lang.String formula) |
Ptg[] |
FormulaEngineImpl.FormulaExpressionImpl.getPtgs() |
protected Ptg[] |
FormulaEngineImpl.parse(java.lang.String formula,
FormulaParsingWorkbook book,
int sheetIndex,
FormulaParseContext context) |
Modifier and Type | Method and Description |
---|---|
void |
DependencyTrackerImpl.addDependency(OperationEvaluationContext ec,
Ptg[] ptgs) |
boolean |
FormulaEngineImpl.FormulaAdjuster.process(int sheetIndex,
Ptg[] tokens,
ParsingBook parsingBook,
FormulaParseContext context) |
protected java.lang.String |
FormulaEngineImpl.renderFormula(ParsingBook parsingBook,
java.lang.String formula,
Ptg[] tokens,
boolean always) |
protected Ref |
FormulaEngineImpl.toDependRef(FormulaParseContext ctx,
ParsingBook parsingBook,
Ptg ptg,
int ptgIndex) |
Constructor and Description |
---|
FormulaExpressionImpl(java.lang.String formula,
Ptg[] ptgs,
Ref[] refs) |
FormulaExpressionImpl(java.lang.String formula,
Ptg[] ptgs,
Ref[] refs,
boolean error,
java.lang.String errorMessage,
boolean multipleArea) |
Modifier and Type | Method and Description |
---|---|
Ptg[] |
FormulaExpression.getPtgs()
Returns the cached parsing things.
|
Modifier and Type | Method and Description |
---|---|
protected Ptg[] |
FormulaEngineEx.parse(java.lang.String formula,
FormulaParsingWorkbook book,
int sheetIndex,
FormulaParseContext context) |
Modifier and Type | Method and Description |
---|---|
void |
DependencyTrackerEx.addDependency(OperationEvaluationContext ec,
Ptg[] ptgs) |
protected java.lang.String |
FormulaEngineEx.renderFormula(ParsingBook parsingBook,
java.lang.String formula,
Ptg[] tokens,
boolean always) |
Copyright © 2005-2010 Potix Corporation. All Rights Reserved.