org.apache.poi.ss.formula.ptg

Class NameXPxg

java.lang.Object

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

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

org.apache.poi.ss.formula.ptg.NameXPxg

All Implemented Interfaces:

Duplicatable, GenericRecord, Pxg

public final class NameXPxg
extends OperandPtg
implements Pxg

A Name, be that a Named Range or a Function / User Defined Function, addressed in the HSSF External Sheet style.

This is XSSF only, as it stores the sheet / book references in String form. The HSSF equivalent using indexes is NameXPtg

Field Summary

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

CLASS_ARRAY, CLASS_REF, CLASS_VALUE, EMPTY_PTG_ARRAY

Constructor Summary

Constructors

Constructor and Description
NameXPxg(int externalWorkbookNumber, java.lang.String sheetName, java.lang.String nameName)
NameXPxg(NameXPxg other)
NameXPxg(java.lang.String nameName)
NameXPxg(java.lang.String sheetName, java.lang.String nameName)

Method Summary

Modifier and Type	Method and Description
NameXPxg	copy()
byte	getDefaultOperandClass()
int	getExternalWorkbookNumber()
java.util.Map<java.lang.String,java.util.function.Supplier<?>>	getGenericProperties()
java.lang.String	getNameName()
java.lang.String	getSheetName()
byte	getSid()
int	getSize()
void	setSheetName(java.lang.String sheetName)
java.lang.String	toFormulaString() return a string representation of this token alone
void	write(LittleEndianOutput out)

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

isBaseToken

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

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

Constructor Detail

NameXPxg

public NameXPxg(int externalWorkbookNumber,
                java.lang.String sheetName,
                java.lang.String nameName)

NameXPxg

public NameXPxg(NameXPxg other)

NameXPxg

public NameXPxg(java.lang.String sheetName,
                java.lang.String nameName)

NameXPxg

public NameXPxg(java.lang.String nameName)

Method Detail

getExternalWorkbookNumber

public int getExternalWorkbookNumber()

Specified by:

getExternalWorkbookNumber in interface Pxg

getSheetName

public java.lang.String getSheetName()

Specified by:

getSheetName in interface Pxg

getNameName

public java.lang.String getNameName()

setSheetName

public void setSheetName(java.lang.String sheetName)

Specified by:

setSheetName in interface Pxg

toFormulaString

public java.lang.String toFormulaString()

Description copied from class: Ptg

return a string representation of this token alone

Specified by:

toFormulaString in interface Pxg

Specified by:

toFormulaString in class Ptg

getDefaultOperandClass

public byte getDefaultOperandClass()

Specified by:

getDefaultOperandClass 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()

Specified by:

getSize in class Ptg

Returns:

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

write

public void write(LittleEndianOutput out)

Specified by:

write in class Ptg

copy

public NameXPxg copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class OperandPtg

Returns:

a deep copy of the implementing class / instance

getGenericProperties

public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()

Specified by:

getGenericProperties in interface GenericRecord