Package org.apache.poi.ss.formula
Class Formula
java.lang.Object
org.apache.poi.ss.formula.Formula
Encapsulates an encoded formula token array.
- Author:
- Josh Micich
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
static Formula
int
int
This method is often used when the formula length does not appear immediately before the encoded token data.Gets the locator for the correspondingSharedFormulaRecord
,ArrayRecord
orTableRecord
if this formula belongs to such a grouping.Ptg[]
static Ptg[]
boolean
static Formula
read
(int encodedTokenLen, LittleEndianInput in) Convenience method forread(int, LittleEndianInput, int)
static Formula
read
(int encodedTokenLen, LittleEndianInput in, int totalEncodedLen) When there are no array constants present, encodedTokenLen==totalEncodedLenvoid
Writes The formula encoding is includes: ushort tokenDataLen tokenData arrayConstantData (if present)void
void
-
Method Details
-
read
Convenience method forread(int, LittleEndianInput, int)
-
read
When there are no array constants present, encodedTokenLen==totalEncodedLen- Parameters:
encodedTokenLen
- number of bytes in the stream taken by the plain formula tokenstotalEncodedLen
- the total number of bytes in the formula (includes trailing encoding for array constants, but does not include 2 bytes for initial ushort encodedTokenLen field.- Returns:
- A new formula object as read from the stream. Possibly empty, never
null
.
-
getTokens
-
serialize
Writes The formula encoding is includes:- ushort tokenDataLen
- tokenData
- arrayConstantData (if present)
-
serializeTokens
-
serializeArrayConstantData
-
getEncodedSize
public int getEncodedSize()- Returns:
- total formula encoding length. The formula encoding includes:
- ushort tokenDataLen
- tokenData
- arrayConstantData (optional)
-
getEncodedTokenSize
public int getEncodedTokenSize()This method is often used when the formula length does not appear immediately before the encoded token data.- Returns:
- the encoded length of the plain formula tokens. This does not include the leading ushort field, nor any trailing array constant data.
-
create
- Parameters:
ptgs
- may benull
- Returns:
- Never
null
(Possibly empty if the supplied ptgs isnull
)
-
getTokens
- Parameters:
formula
- may benull
- Returns:
- possibly
null
(if the supplied formula isnull
)
-
copy
-
getExpReference
Gets the locator for the correspondingSharedFormulaRecord
,ArrayRecord
orTableRecord
if this formula belongs to such a grouping. TheCellReference
returned by this method will match the top left corner of the range of that grouping. The return value is usually not the same as the location of the cell containing this formula.- Returns:
- the firstRow & firstColumn of an array formula or shared formula that this formula
belongs to.
null
if this formula is not part of an array or shared formula.
-
isSame
-