Package org.apache.poi.ss.formula.ptg

Class AttrPtg

java.lang.Object

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

org.apache.poi.ss.formula.ptg.ControlPtg

org.apache.poi.ss.formula.ptg.AttrPtg

All Implemented Interfaces:

Serializable, Duplicatable, GenericRecord

public final class AttrPtg
extends ControlPtg

"Special Attributes"

This seems to be a Misc Stuff and Junk record. One function it serves is in SUM functions (i.e. SUM(A1:A3) causes an area PTG then an ATTR with the SUM option set)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AttrPtg.SpaceType

Field Summary

Fields

Modifier and Type	Field	Description
static byte	sid
static AttrPtg	SUM

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

CLASS_ARRAY, CLASS_REF, CLASS_VALUE, EMPTY_PTG_ARRAY

Constructor Summary

Constructors

Constructor	Description
AttrPtg(LittleEndianInput in)

Method Summary

Modifier and Type	Method	Description
AttrPtg	copy()
static AttrPtg	createIf(int dist)
static AttrPtg	createSkip(int dist)
static AttrPtg	createSpace(int type, int count)
int	getChooseFuncOffset()
short	getData()
static AttrPtg	getFunIn(int funcId)
Map<String,Supplier<?>>	getGenericProperties()
int[]	getJumpTable()
int	getNumberOfOperands()
byte	getSid()
int	getSize(SpreadsheetVersion version)
static AttrPtg	getSumSingle()
int	getType()
boolean	isFunIn()
boolean	isOptimizedChoose()
boolean	isOptimizedIf()
boolean	isSemiVolatile()
boolean	isSkip()
boolean	isSpace()
boolean	isSum()
String	toFormulaString()	return a string representation of this token alone
String	toFormulaString(String[] operands)
void	write(LittleEndianOutput out, SpreadsheetVersion version)

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

getDefaultOperandClass, isBaseToken

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

createPtg, createPtg, doesFormulaReferToDeletedCell, getEncodedSize, getEncodedSize, getEncodedSizeWithoutArrayData, getEncodedSizeWithoutArrayData, getPtgClass, getRVAType, readTokens, readTokens, serializePtgs, 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

SUM

public static final AttrPtg SUM

Constructor Detail

AttrPtg

public AttrPtg(LittleEndianInput in)

Method Detail

createSpace

public static AttrPtg createSpace(int type,
                                  int count)

Parameters:

type - a constant from SpaceType

count - the number of space characters

createIf

public static AttrPtg createIf(int dist)

Parameters:

dist - distance (in bytes) to start of either

• false parameter
• tFuncVar(IF) token (when false parameter is not present)

createSkip

public static AttrPtg createSkip(int dist)

Parameters:

dist - distance (in bytes) to position behind tFuncVar(IF) token (minus 1)

getSumSingle

public static AttrPtg getSumSingle()

getFunIn

public static AttrPtg getFunIn(int funcId)

isSemiVolatile

public boolean isSemiVolatile()

isOptimizedIf

public boolean isOptimizedIf()

isOptimizedChoose

public boolean isOptimizedChoose()

isSum

public boolean isSum()

isSkip

public boolean isSkip()

isSpace

public boolean isSpace()

isFunIn

public boolean isFunIn()

getData

public short getData()

getJumpTable

public int[] getJumpTable()

getChooseFuncOffset

public int getChooseFuncOffset()

write

public void write(LittleEndianOutput out,
                  SpreadsheetVersion version)

Specified by:

write in class Ptg

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(SpreadsheetVersion version)

Specified by:

getSize in class Ptg

Returns:

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

toFormulaString

public String toFormulaString(String[] operands)

getNumberOfOperands

public int getNumberOfOperands()

getType

public int getType()

toFormulaString

public String toFormulaString()

Description copied from class: Ptg

return a string representation of this token alone

Specified by:

toFormulaString in class Ptg

copy

public AttrPtg copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class Ptg

Returns:

a deep copy of the implementing class / instance

getGenericProperties

public Map<String,Supplier<?>> getGenericProperties()