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

Class RefPtg

java.lang.Object

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

org.apache.poi.ss.formula.ptg.OperandPtg

org.apache.poi.ss.formula.ptg.RefPtgBase

org.apache.poi.ss.formula.ptg.RefPtg

All Implemented Interfaces:

Serializable, Duplicatable, GenericRecord

public final class RefPtg
extends RefPtgBase

ReferencePtg - handles references (such as A1, A2, IA4)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static byte	sid

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
RefPtg(int row, int column, boolean isRowRelative, boolean isColumnRelative)
RefPtg(String cellref)	Takes in a String representation of a cell reference and fills out the numeric fields.
RefPtg(RefPtg other)
RefPtg(CellReference cr)
RefPtg(LittleEndianInput in)
RefPtg(LittleEndianInput in, SpreadsheetVersion version)

Method Summary

Modifier and Type	Method	Description
RefPtg	copy()
byte	getSid()
int	getSize(SpreadsheetVersion version)
String	toFormulaString()	return a string representation of this token alone
void	write(LittleEndianOutput out, SpreadsheetVersion version)

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

equals, formatReferenceAsString, getColumn, getDefaultOperandClass, getGenericProperties, getRow, hashCode, isColRelative, isRowRelative, readCoordinates, setColRelative, setColumn, setRow, setRowRelative, writeCoordinates

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

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, finalize, getClass, 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

Constructor Detail

RefPtg

public RefPtg(String cellref)

Takes in a String representation of a cell reference and fills out the numeric fields.

RefPtg

public RefPtg(RefPtg other)

RefPtg

public RefPtg(int row,
              int column,
              boolean isRowRelative,
              boolean isColumnRelative)

RefPtg

public RefPtg(LittleEndianInput in)

RefPtg

public RefPtg(LittleEndianInput in,
              SpreadsheetVersion version)

RefPtg

public RefPtg(CellReference cr)

Method Detail

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

copy

public RefPtg copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class OperandPtg

Returns:

a deep copy of the implementing class / instance

write

public void write(LittleEndianOutput out,
                  SpreadsheetVersion version)

Specified by:

write in class Ptg

toFormulaString

public final String toFormulaString()

Description copied from class: Ptg

return a string representation of this token alone

Specified by:

toFormulaString in class Ptg

getSize

public final int getSize(SpreadsheetVersion version)

Specified by:

getSize in class Ptg

Returns:

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