org.apache.poi.ss.formula.ptg

Class UnionPtg

java.lang.Object

org.apache.poi.ss.formula.ptg.Ptg

org.apache.poi.ss.formula.ptg.OperationPtg

org.apache.poi.ss.formula.ptg.UnionPtg

All Implemented Interfaces:

Duplicatable, GenericRecord

public final class UnionPtg
extends OperationPtg

Author:

Glen Stampoultzis (glens at apache.org)

Field Summary

Fields

Modifier and Type	Field and Description
static UnionPtg	instance
static byte	sid

Fields inherited from class org.apache.poi.ss.formula.ptg.OperationPtg

TYPE_BINARY, TYPE_FUNCTION, TYPE_UNARY

Fields inherited from class org.apache.poi.ss.formula.ptg.Ptg

CLASS_ARRAY, CLASS_REF, CLASS_VALUE, EMPTY_PTG_ARRAY

Method Summary

Modifier and Type	Method and Description
UnionPtg	copy()
int	getNumberOfOperands() The number of operands expected by the operations
byte	getSid()
int	getSize()
boolean	isBaseToken()
java.lang.String	toFormulaString() return a string representation of this token alone
java.lang.String	toFormulaString(java.lang.String[] operands) implementation of method from OperationsPtg
void	write(LittleEndianOutput out)

Methods inherited from class org.apache.poi.ss.formula.ptg.OperationPtg

getDefaultOperandClass, getGenericProperties

Methods inherited from class org.apache.poi.ss.formula.ptg.Ptg

createPtg, doesFormulaReferToDeletedCell, getEncodedSize, getEncodedSizeWithoutArrayData, getPtgClass, getRVAType, readTokens, serializePtgs, setClass, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

getGenericChildren, getGenericRecordType

Field Detail

sid

public static final byte sid

See Also:

Constant Field Values

instance

public static final UnionPtg instance

Method Detail

isBaseToken

public final boolean isBaseToken()

Specified by:

isBaseToken in class Ptg

Returns:

false if this token is classified as 'reference', 'value', or 'array'

getSid

public byte getSid()

Specified by:

getSid in class Ptg

Returns:

structure id of the parsed thing, or -1 if the record has no sid

getSize

public int getSize()

Specified by:

getSize in class Ptg

Returns:

the encoded length of this Ptg, including the initial Ptg type identifier byte.

write

public void write(LittleEndianOutput out)

Specified by:

write in class Ptg

toFormulaString

public java.lang.String toFormulaString()

Description copied from class: Ptg

return a string representation of this token alone

Specified by:

toFormulaString in class Ptg

toFormulaString

public java.lang.String toFormulaString(java.lang.String[] operands)

implementation of method from OperationsPtg

Specified by:

toFormulaString in class OperationPtg

See Also:

OperationPtg.getNumberOfOperands()

getNumberOfOperands

public int getNumberOfOperands()

Description copied from class: OperationPtg

The number of operands expected by the operations

Specified by:

getNumberOfOperands in class OperationPtg

copy

public UnionPtg copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class Ptg

Returns:

a deep copy of the implementing class / instance