Uses of Class
org.apache.poi.ss.formula.ptg.Ptg

Packages that use Ptg

Package	Description
org.apache.poi.hssf.model	Provides low level API structures for reading, writing, modifying XLS files.
org.apache.poi.hssf.record	Record package contains class representations for XLS binary strutures.
org.apache.poi.hssf.record.aggregates	The record aggregates are not real "records" but collections of records that act as a single record.
org.apache.poi.hssf.record.cf
org.apache.poi.hssf.record.chart
org.apache.poi.hssf.usermodel	The usermodel package maps HSSF low level structures to familiar workbook/sheet model
org.apache.poi.ss.formula	This package contains common internal POI code for manipulating formulas.
org.apache.poi.ss.formula.eval
org.apache.poi.ss.formula.ptg	The formula package contains binary PTG structures used in Formulas
org.apache.poi.ss.usermodel
org.apache.poi.xssf.streaming
org.apache.poi.xssf.usermodel

Uses of Ptg in org.apache.poi.hssf.model

Methods in org.apache.poi.hssf.model that return Ptg

Modifier and Type	Method	Description
static Ptg[]	HSSFFormulaParser.parse(String formula, HSSFWorkbook workbook)	Convenience method for parsing cell formulas.
static Ptg[]	HSSFFormulaParser.parse(String formula, HSSFWorkbook workbook, FormulaType formulaType)
static Ptg[]	HSSFFormulaParser.parse(String formula, HSSFWorkbook workbook, FormulaType formulaType, int sheetIndex)

Methods in org.apache.poi.hssf.model with parameters of type Ptg

Modifier and Type	Method	Description
static String	HSSFFormulaParser.toFormulaString(HSSFWorkbook book, Ptg[] ptgs)	Static method to convert an array of Ptgs in RPN order to a human readable string format in infix mode.

Uses of Ptg in org.apache.poi.hssf.record

Methods in org.apache.poi.hssf.record that return Ptg

Modifier and Type	Method	Description
Ptg	LbsDataSubRecord.getFormula()
Ptg[]	DVRecord.getFormula1()
Ptg[]	DVRecord.getFormula2()
Ptg[]	ArrayRecord.getFormulaTokens()
Ptg[]	SharedFormulaRecord.getFormulaTokens(FormulaRecord formula)	Convert formula into an array of Ptg tokens.
Ptg	TextObjectRecord.getLinkRefPtg()
Ptg[]	NameRecord.getNameDefinition()	gets the definition, reference (Formula)
Ptg[]	ExternalNameRecord.getParsedExpression()
Ptg[]	FormulaRecord.getParsedExpression()
Ptg[]	OldFormulaRecord.getParsedExpression()
Ptg[]	CFRuleBase.getParsedExpression1()	get the stack of the 1st expression as a list
Ptg[]	CFRuleBase.getParsedExpression2()	get the stack of the 2nd expression as a list
Ptg[]	CFRule12Record.getParsedExpressionScale()	get the stack of the scale expression as a list
static Ptg[]	CFRuleBase.parseFormula(String formula, HSSFSheet sheet)	TODO - parse conditional format formulas properly i.e.

Methods in org.apache.poi.hssf.record with parameters of type Ptg

Modifier and Type	Method	Description
void	NameRecord.setNameDefinition(Ptg[] ptgs)
void	ExternalNameRecord.setParsedExpression(Ptg[] ptgs)
void	FormulaRecord.setParsedExpression(Ptg[] ptgs)
void	CFRuleBase.setParsedExpression1(Ptg[] ptgs)
void	CFRuleBase.setParsedExpression2(Ptg[] ptgs)
void	CFRule12Record.setParsedExpressionScale(Ptg[] ptgs)

Constructors in org.apache.poi.hssf.record with parameters of type Ptg

Modifier	Constructor	Description
protected	CFRuleBase(byte conditionType, byte comparisonOperation, Ptg[] formula1, Ptg[] formula2)
	DVRecord(int validationType, int operator, int errorStyle, boolean emptyCellAllowed, boolean suppressDropDownArrow, boolean isExplicitList, boolean showPromptBox, String promptTitle, String promptText, boolean showErrorBox, String errorTitle, String errorText, Ptg[] formula1, Ptg[] formula2, CellRangeAddressList regions)

Uses of Ptg in org.apache.poi.hssf.record.aggregates

Methods in org.apache.poi.hssf.record.aggregates that return Ptg

Modifier and Type	Method	Description
Ptg[]	FormulaRecordAggregate.getFormulaTokens()

Methods in org.apache.poi.hssf.record.aggregates with parameters of type Ptg

Modifier and Type	Method	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

Uses of Ptg in org.apache.poi.hssf.record.cf

Methods in org.apache.poi.hssf.record.cf that return Ptg

Modifier and Type	Method	Description
Ptg[]	Threshold.getParsedExpression()

Methods in org.apache.poi.hssf.record.cf with parameters of type Ptg

Modifier and Type	Method	Description
void	Threshold.setParsedExpression(Ptg[] ptgs)

Uses of Ptg in org.apache.poi.hssf.record.chart

Methods in org.apache.poi.hssf.record.chart that return Ptg

Modifier and Type	Method	Description
Ptg[]	LinkedDataRecord.getFormulaOfLink()	Get the formula of link field for the LinkedData record.

Methods in org.apache.poi.hssf.record.chart with parameters of type Ptg

Modifier and Type	Method	Description
void	LinkedDataRecord.setFormulaOfLink(Ptg[] ptgs)	Set the formula of link field for the LinkedData record.

Uses of Ptg in org.apache.poi.hssf.usermodel

Methods in org.apache.poi.hssf.usermodel that return Ptg

Modifier and Type	Method	Description
Ptg	HSSFEvaluationWorkbook.get3DReferencePtg(AreaReference areaRef, SheetIdentifier sheet)
Ptg	HSSFEvaluationWorkbook.get3DReferencePtg(CellReference cr, SheetIdentifier sheet)
Ptg[]	HSSFEvaluationWorkbook.getFormulaTokens(EvaluationCell evalCell)

Uses of Ptg in org.apache.poi.ss.formula

Methods in org.apache.poi.ss.formula that return Ptg

Modifier and Type	Method	Description
Ptg[]	SharedFormula.convertSharedFormulas(Ptg[] ptgs, int formulaRow, int formulaColumn)	Creates a non shared formula from the shared formula counterpart, i.e.
Ptg	FormulaParsingWorkbook.get3DReferencePtg(AreaReference area, SheetIdentifier sheet)	Produce the appropriate Ptg for a 3d area reference
Ptg	FormulaParsingWorkbook.get3DReferencePtg(CellReference cell, SheetIdentifier sheet)	Produce the appropriate Ptg for a 3d cell reference
Ptg[]	EvaluationWorkbook.getFormulaTokens(EvaluationCell cell)
Ptg[]	EvaluationName.getNameDefinition()
Ptg	FormulaParsingWorkbook.getNameXPtg(String name, SheetIdentifier sheet)	Return an external name (named range, function, user-defined function) Ptg
Ptg[]	Formula.getTokens()
static Ptg[]	Formula.getTokens(Formula formula)	Gets the Ptg array from the supplied Formula.
static Ptg[]	FormulaParser.parse(String formula, FormulaParsingWorkbook workbook, FormulaType formulaType, int sheetIndex)	Parse a formula into an array of tokens Side effect: creates name (Workbook.createName()) if formula contains unrecognized names (names are likely UDFs)
static Ptg[]	FormulaParser.parse(String formula, FormulaParsingWorkbook workbook, FormulaType formulaType, int sheetIndex, int rowIndex)	Parse a formula into an array of tokens Side effect: creates name (Workbook.createName()) if formula contains unrecognized names (names are likely UDFs)

Methods in org.apache.poi.ss.formula with parameters of type Ptg

Modifier and Type	Method	Description
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)	Creates a Formula object from a supplied Ptg array.
ValueEval	WorkbookEvaluator.evaluateFormula(OperationEvaluationContext ec, Ptg[] ptgs)	Evaluates the given formula tokens in the given context.
static String	FormulaRenderer.toFormulaString(FormulaRenderingWorkbook book, Ptg[] ptgs)	Static method to convert an array of Ptgs in RPN order to a human readable string format in infix mode.

Uses of Ptg in org.apache.poi.ss.formula.eval

Constructors in org.apache.poi.ss.formula.eval with parameters of type Ptg

Modifier	Constructor	Description
	NumberEval(Ptg ptg)
	StringEval(Ptg ptg)

Uses of Ptg in org.apache.poi.ss.formula.ptg

Subclasses of Ptg in org.apache.poi.ss.formula.ptg

Modifier and Type	Class	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
final class	AddPtg	Addition operator PTG the "+" binomial operator.
class	Area2DPtgBase	Common superclass of 2-D area refs
final class	Area3DPtg	Area 3D Ptg - 3D reference (Sheet + Area)
final class	Area3DPxg	XSSF Area 3D Reference (Sheet + Area)
final class	AreaErrPtg	AreaErr - handles deleted cell area references.
final class	AreaNPtg	Specifies a rectangular area of cells A1:A4 for instance.
final class	AreaPtg	Specifies a rectangular area of cells A1:A4 for instance.
class	AreaPtgBase	Specifies a rectangular area of cells A1:A4 for instance.
final 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.
final class	AttrPtg	"Special Attributes"
final class	BoolPtg	Boolean (boolean) Stores a (java) boolean value in a formula.
final class	ConcatPtg
class	ControlPtg
final class	Deleted3DPxg	An XSSF only representation of a reference to a deleted area
final class	DeletedArea3DPtg	Deleted Area 3D Ptg - 3D referecnce (Sheet + Area)
final class	DeletedRef3DPtg	Deleted Reference 3D Ptg
final class	DividePtg	This PTG implements the standard binomial divide "/"
final class	EqualPtg
final class	ErrPtg
final class	ExpPtg
final class	FuncPtg
final class	FuncVarPtg
final class	GreaterEqualPtg	PTG class to implement greater or equal to
final class	GreaterThanPtg	Greater than operator PTG ">"
final class	IntersectionPtg
final class	IntPtg	Integer (unsigned short integer) Stores an unsigned short value (java int) in a formula
final class	LessEqualPtg	Ptg class to implement less than or equal
final class	LessThanPtg	Less than operator PTG "<".
final class	MemAreaPtg
final class	MemErrPtg
final class	MemFuncPtg
final class	MissingArgPtg	Missing Function Arguments
final class	MultiplyPtg	Implements the standard mathematical multiplication "*"
final class	NamePtg	See the spec at 2.5.198.76 PtgName
final class	NameXPtg	A Name, be that a Named Range or a Function / User Defined Function, addressed in the HSSF External Sheet style.
final class	NameXPxg	A Name, be that a Named Range or a Function / User Defined Function, addressed in the HSSF External Sheet style.
final class	NotEqualPtg	Ptg class to implement not equal
final 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
final 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
final class	PercentPtg	Percent PTG.
final class	PowerPtg
final class	RangePtg
final class	Ref3DPtg	Reference 3D Ptg
final class	Ref3DPxg	XSSF 3D Reference
final class	RefErrorPtg	RefError - handles deleted cell reference
final class	RefNPtg
final 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 Ptgs that represent simple constant values.
final class	StringPtg	String Stores a String value in a formula value stored in the format <length 2 bytes>char[]
final class	SubtractPtg
final class	TblPtg	This ptg indicates a data table.
final class	UnaryMinusPtg	Unary Plus operator - does not have any effect on the operand
final class	UnaryPlusPtg	Unary Plus operator - does not have any effect on the operand
final class	UnionPtg
class	UnknownPtg
class	ValueOperatorPtg	Common superclass of all value operators.

Fields in org.apache.poi.ss.formula.ptg declared as Ptg

Modifier and Type	Field	Description
static final Ptg[]	Ptg.EMPTY_PTG_ARRAY
static final Ptg	MissingArgPtg.instance

Methods in org.apache.poi.ss.formula.ptg that return Ptg

Modifier and Type	Method	Description
abstract Ptg	Ptg.copy()
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.

Methods in org.apache.poi.ss.formula.ptg with parameters of type Ptg

Modifier and Type	Method	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.

Constructors in org.apache.poi.ss.formula.ptg with parameters of type Ptg

Modifier	Constructor	Description
protected	Ptg(Ptg other)

Uses of Ptg in org.apache.poi.ss.usermodel

Methods in org.apache.poi.ss.usermodel with parameters of type Ptg

Modifier and Type	Method	Description
protected boolean	RangeCopier.adjustInBothDirections(Ptg[] ptgs, int sheetIndex, int deltaX, int deltaY)

Uses of Ptg in org.apache.poi.xssf.streaming

Methods in org.apache.poi.xssf.streaming that return Ptg

Modifier and Type	Method	Description
Ptg[]	SXSSFEvaluationWorkbook.getFormulaTokens(EvaluationCell evalCell)

Uses of Ptg in org.apache.poi.xssf.usermodel

Methods in org.apache.poi.xssf.usermodel that return Ptg

Modifier and Type	Method	Description
Ptg	BaseXSSFEvaluationWorkbook.get3DReferencePtg(AreaReference area, SheetIdentifier sheet)
Ptg	BaseXSSFEvaluationWorkbook.get3DReferencePtg(CellReference cell, SheetIdentifier sheet)
Ptg[]	XSSFEvaluationWorkbook.getFormulaTokens(EvaluationCell evalCell)	The parsed tokens are cached by the XSSFEvaluationSheet the cell belongs to, so a formula is parsed once per evaluator rather than every time it is (re-)evaluated; the cache is kept in step by XSSFEvaluationWorkbook.clearAllCachedResultValues() and the sheet's notifyUpdateCell/notifyDeleteCell.