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

Class NamePtg

java.lang.Object

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

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

org.apache.poi.ss.formula.ptg.NamePtg

All Implemented Interfaces:

Serializable, Duplicatable, GenericRecord, WorkbookDependentFormula

public final class NamePtg
extends OperandPtg
implements WorkbookDependentFormula

See the spec at 2.5.198.76 PtgName

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static short	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
NamePtg(int nameIndex)
NamePtg(NamePtg other)
NamePtg(LittleEndianInput in)	Creates new NamePtg

Method Summary

Modifier and Type	Method	Description
NamePtg	copy()
byte	getDefaultOperandClass()
Map<String,Supplier<?>>	getGenericProperties()
int	getIndex()
String	getNameName()
byte	getSid()
int	getSize(SpreadsheetVersion version)
String	toFormulaString()	return a string representation of this token alone
String	toFormulaString(FormulaRenderingWorkbook book)
String	toInternalFormulaString(FormulaRenderingWorkbook book)
void	write(LittleEndianOutput out, SpreadsheetVersion version)

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, 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 short sid

See Also:

Constant Field Values

Constructor Detail

NamePtg

public NamePtg(int nameIndex)

Parameters:

nameIndex - zero-based index to name within workbook

NamePtg

public NamePtg(NamePtg other)

NamePtg

public NamePtg(LittleEndianInput in)

Creates new NamePtg

Method Detail

getIndex

public int getIndex()

Returns:

zero based index to a defined name record in the LinkTable

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(FormulaRenderingWorkbook book)

Specified by:

toFormulaString in interface WorkbookDependentFormula

getNameName

public String getNameName()

toFormulaString

public String toFormulaString()

Description copied from class: Ptg

return a string representation of this token alone

Specified by:

toFormulaString in class Ptg

getDefaultOperandClass

public byte getDefaultOperandClass()

Specified by:

getDefaultOperandClass in class Ptg

copy

public NamePtg copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class OperandPtg

Returns:

a deep copy of the implementing class / instance

getGenericProperties

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

Specified by:

getGenericProperties in interface GenericRecord

toInternalFormulaString

public String toInternalFormulaString(FormulaRenderingWorkbook book)

Specified by:

toInternalFormulaString in interface WorkbookDependentFormula