loci.poi.hssf.record.formula

Class Ptg

java.lang.Object

loci.poi.hssf.record.formula.Ptg

Direct Known Subclasses:

Area3DPtg, AreaPtg, ArrayPtg, BoolPtg, ControlPtg, ErrPtg, ExpPtg, IntPtg, MemAreaPtg, MissingArgPtg, NamePtg, NameXPtg, NumberPtg, OperationPtg, Ref3DPtg, ReferencePtg, RefErrorPtg, StringPtg, UnknownPtg

public abstract class Ptg
extends Object

Author:

andy, avik, Jason Height (jheight at chariot dot net dot au)

Field Summary

Fields

Modifier and Type	Field and Description
static byte	CLASS_ARRAY
static byte	CLASS_REF
static byte	CLASS_VALUE
protected byte	ptgClass

Constructor Summary

Constructors

Constructor and Description
Ptg()

Method Summary

Methods

Modifier and Type	Method and Description
abstract Object	clone()
static Stack	createParsedExpressionTokens(short size, RecordInputStream in)
static Ptg	createPtg(RecordInputStream in)
byte[]	getBytes()
abstract byte	getDefaultOperandClass()
byte	getPtgClass() returns the class (REF/VALUE/ARRAY) for this Ptg
abstract int	getSize()
static int	serializePtgStack(Stack expression, byte[] array, int offset)
void	setClass(byte thePtgClass)
String	toDebugString() dump a debug representation (hexdump) to a string
abstract String	toFormulaString(Workbook book) return a string representation of this token alone
String	toString() Overridden toString method to ensure object hash is not printed.
abstract void	writeBytes(byte[] array, int offset) write this Ptg to a byte array

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_REF

public static final byte CLASS_REF

See Also:

Constant Field Values

CLASS_VALUE

public static final byte CLASS_VALUE

See Also:

Constant Field Values

CLASS_ARRAY

public static final byte CLASS_ARRAY

See Also:

Constant Field Values

ptgClass

protected byte ptgClass

Constructor Detail

Ptg

public Ptg()

Method Detail

createParsedExpressionTokens

public static Stack createParsedExpressionTokens(short size,
                                 RecordInputStream in)

createPtg

public static Ptg createPtg(RecordInputStream in)

serializePtgStack

public static int serializePtgStack(Stack expression,
                    byte[] array,
                    int offset)

getSize

public abstract int getSize()

getBytes

public final byte[] getBytes()

writeBytes

public abstract void writeBytes(byte[] array,
              int offset)

write this Ptg to a byte array

toFormulaString

public abstract String toFormulaString(Workbook book)

return a string representation of this token alone

toDebugString

public String toDebugString()

dump a debug representation (hexdump) to a string

toString

public String toString()

Overridden toString method to ensure object hash is not printed. This helps get rid of gratuitous diffs when comparing two dumps Subclasses may output more relevant information by overriding this method

Overrides:

toString in class Object

setClass

public void setClass(byte thePtgClass)

getPtgClass

public byte getPtgClass()

returns the class (REF/VALUE/ARRAY) for this Ptg

getDefaultOperandClass

public abstract byte getDefaultOperandClass()

clone

public abstract Object clone()

Overrides:

clone in class Object