Top Description Fields Constructors Methods
org.apache.poi.ss.formula.ptg

public final Class NameXPtg

extends OperandPtg
implements WorkbookDependentFormula
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.formula.WorkbookDependentFormula
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.ss.formula.FormulaRenderingWorkbook, .WorkbookDependentFormula, org.apache.poi.util.GenericRecordUtil, .LittleEndianInput, .LittleEndianOutput
A Name, be that a Named Range or a Function / User Defined Function, addressed in the HSSF External Sheet style.

This is HSSF only, as it matches the HSSF file format way of referring to the sheet by an extern index. The XSSF equivalent is NameXPxg

Field Summary

Modifier and TypeField and Description
private final int
_nameNumber

index to defined name or externname table(1 based)

private final int
_reserved

reserved must be 0

private final int
_sheetRefIndex

index to REF entry in externsheet record

public static final short
sid

private static final int
SIZE

Constructor Summary

AccessConstructor and Description
private
NameXPtg(int sheetRefIndex, int nameNumber, int reserved)

public
NameXPtg(int
index to REF entry in externsheet record
sheetRefIndex, int
index to defined name or externname table
nameIndex)

public
NameXPtg(LittleEndianInput in)

Method Summary

Modifier and TypeMethod and Description
public NameXPtg
copy()

Implements abstract org.apache.poi.ss.formula.ptg.OperandPtg.copy.

Implements org.apache.poi.common.Duplicatable.copy.

public byte
getDefaultOperandClass()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getDefaultOperandClass.

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

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public int
getNameIndex()

public int
getSheetRefIndex()

public byte
getSid()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSid.

public int
getSize()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSize.

public String
toFormulaString(FormulaRenderingWorkbook book)

Implements org.apache.poi.ss.formula.WorkbookDependentFormula.toFormulaString.

public String
toFormulaString()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

return a string representation of this token alone

public void
write(LittleEndianOutput out)

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.write.

Inherited from org.apache.poi.ss.formula.ptg.OperandPtg:
isBaseToken

Field Detail

_nameNumberback to summary
private final int _nameNumber

index to defined name or externname table(1 based)

_reservedback to summary
private final int _reserved

reserved must be 0

_sheetRefIndexback to summary
private final int _sheetRefIndex

index to REF entry in externsheet record

sidback to summary
public static final short sid
SIZEback to summary
private static final int SIZE

Constructor Detail

NameXPtgback to summary
private NameXPtg(int sheetRefIndex, int nameNumber, int reserved)
NameXPtgback to summary
public NameXPtg(int sheetRefIndex, int nameIndex)
Parameters
sheetRefIndex:int

index to REF entry in externsheet record

nameIndex:int

index to defined name or externname table

NameXPtgback to summary
public NameXPtg(LittleEndianInput in)

Method Detail

copyback to summary
public NameXPtg copy()

Implements abstract org.apache.poi.ss.formula.ptg.OperandPtg.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:NameXPtg

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getDefaultOperandClassback to summary
public byte getDefaultOperandClass()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getDefaultOperandClass.

Annotations
@Override
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getNameIndexback to summary
public int getNameIndex()
getSheetRefIndexback to summary
public int getSheetRefIndex()
getSidback to summary
public byte getSid()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSid.

Returns:byte

Doc from org.apache.poi.ss.formula.ptg.Ptg.getSid.

structure id of the parsed thing, or -1 if the record has no sid

Annotations
@Override
getSizeback to summary
public int getSize()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSize.

Returns:int

Doc from org.apache.poi.ss.formula.ptg.Ptg.getSize.

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

toFormulaStringback to summary
public String toFormulaString(FormulaRenderingWorkbook book)

Implements org.apache.poi.ss.formula.WorkbookDependentFormula.toFormulaString.

toFormulaStringback to summary
public String toFormulaString()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

Doc from org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

return a string representation of this token alone

writeback to summary
public void write(LittleEndianOutput out)

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.write.