Package org.apache.poi.ss.formula.ptg
Class ArrayPtg
java.lang.Object
org.apache.poi.ss.formula.ptg.Ptg
org.apache.poi.ss.formula.ptg.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. The next Ptg in the expression then follows.
It is only after the "size" of all the Ptgs is met, that the ArrayPtg data is actually
held after this. So Ptg.createParsedExpression keeps track of the number of
ArrayPtg elements and need to parse the data upto the FORMULA record size.
- Author:
- Jason Height (jheight at chariot dot net dot au)
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The size of the plain tArray token written within the standard formula tokens (not including the data which comes after all formula tokens)static final byte
Fields inherited from class org.apache.poi.ss.formula.ptg.Ptg
CLASS_ARRAY, CLASS_REF, CLASS_VALUE, EMPTY_PTG_ARRAY
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
byte
int
int
getSize()
This size includes the size of the array Ptg plus the Array Ptg Token value sizeObject[][]
boolean
return a string representation of this token alonetoString()
Overridden toString method to ensure object hash is not printed.void
write
(LittleEndianOutput out) int
Methods inherited from class org.apache.poi.ss.formula.ptg.Ptg
createPtg, doesFormulaReferToDeletedCell, getEncodedSize, getEncodedSizeWithoutArrayData, getPtgClass, getRVAType, readTokens, serializePtgs, setClass
-
Field Details
-
sid
public static final byte sid- See Also:
-
PLAIN_TOKEN_SIZE
public static final int PLAIN_TOKEN_SIZEThe size of the plain tArray token written within the standard formula tokens (not including the data which comes after all formula tokens)- See Also:
-
-
Constructor Details
-
ArrayPtg
- Parameters:
values2d
- array values arranged in rows
-
-
Method Details
-
getTokenArrayValues
- Returns:
- 2-d array (inner index is rowIx, outer index is colIx)
-
isBaseToken
public boolean isBaseToken()- Specified by:
isBaseToken
in classPtg
- Returns:
false
if this token is classified as 'reference', 'value', or 'array'
-
toString
Description copied from class:Ptg
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 -
write
-
writeTokenValueBytes
-
getRowCount
public int getRowCount() -
getColumnCount
public int getColumnCount() -
getSize
public int getSize()This size includes the size of the array Ptg plus the Array Ptg Token value size -
toFormulaString
Description copied from class:Ptg
return a string representation of this token alone- Specified by:
toFormulaString
in classPtg
-
getDefaultOperandClass
public byte getDefaultOperandClass()- Specified by:
getDefaultOperandClass
in classPtg
-