org.apache.poi.hssf.record.formula
Class NamePtg

java.lang.Object
  extended by org.apache.poi.hssf.record.formula.Ptg
      extended by org.apache.poi.hssf.record.formula.OperandPtg
          extended by org.apache.poi.hssf.record.formula.NamePtg
All Implemented Interfaces:
java.lang.Cloneable

public final class NamePtg
extends OperandPtg

Author:
andy, Jason Height (jheight at chariot dot net dot au)

Field Summary
static short sid
           
 
Fields inherited from class org.apache.poi.hssf.record.formula.Ptg
CLASS_ARRAY, CLASS_REF, CLASS_VALUE
 
Constructor Summary
NamePtg(RecordInputStream in)
          Creates new NamePtg
NamePtg(java.lang.String name, HSSFWorkbook book)
          Creates new NamePtg and sets its name index to that of the corresponding defined name record in the workbook.
 
Method Summary
 byte getDefaultOperandClass()
           
 int getIndex()
           
 int getSize()
           
 java.lang.String toFormulaString(HSSFWorkbook book)
          return a string representation of this token alone
 void writeBytes(byte[] array, int offset)
          write this Ptg to a byte array
 
Methods inherited from class org.apache.poi.hssf.record.formula.OperandPtg
isBaseToken
 
Methods inherited from class org.apache.poi.hssf.record.formula.Ptg
clone, copy, createParsedExpressionTokens, createPtg, getBytes, getEncodedSize, getEncodedSize, getPtgClass, readTokens, serializePtgs, serializePtgStack, setClass, toDebugString, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sid

public static final short sid
See Also:
Constant Field Values
Constructor Detail

NamePtg

public NamePtg(java.lang.String name,
               HSSFWorkbook book)
Creates new NamePtg and sets its name index to that of the corresponding defined name record in the workbook. The search for the name record is case insensitive. If it is not found, it gets created.


NamePtg

public NamePtg(RecordInputStream in)
Creates new NamePtg

Method Detail

getIndex

public int getIndex()
Returns:
zero based index to a defined name record in the LinkTable

writeBytes

public void writeBytes(byte[] array,
                       int offset)
Description copied from class: Ptg
write this Ptg to a byte array

Specified by:
writeBytes in class Ptg

getSize

public int getSize()
Specified by:
getSize in class Ptg
Returns:
the encoded length of this Ptg, including the initial Ptg type identifier byte.

toFormulaString

public java.lang.String toFormulaString(HSSFWorkbook book)
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


Copyright 2008 The Apache Software Foundation or its licensors, as applicable.