loci.poi.hssf.record.formula

Class ReferencePtg

java.lang.Object

loci.poi.hssf.record.formula.Ptg

loci.poi.hssf.record.formula.ReferencePtg

Direct Known Subclasses:

RefAPtg, RefNAPtg, RefNPtg, RefNVPtg, RefVPtg

public class ReferencePtg
extends Ptg

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

Author:

Andrew C. Oliver (acoliver@apache.org), Jason Height (jheight at chariot dot net dot au)

Field Summary

Fields

Modifier and Type	Field and Description
private BitField	colRelative
private BitField	column
private short	field_1_row The row number, between 0 and 65535, but stored as a signed short between -32767 and 32768.
private short	field_2_col The column number, between 0 and ??
private static int	MAX_ROW_NUMBER
private BitField	rowRelative
static byte	sid
private static int	SIZE

Fields inherited from class loci.poi.hssf.record.formula.Ptg

CLASS_ARRAY, CLASS_REF, CLASS_VALUE, ptgClass

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReferencePtg()
	ReferencePtg(RecordInputStream in) Creates new ValueReferencePtg
	ReferencePtg(short row, short column, boolean isRowRelative, boolean isColumnRelative)
	ReferencePtg(String cellref) Takes in a String represnetation of a cell reference and fills out the numeric fields.

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
short	getColumn()
short	getColumnRaw()
byte	getDefaultOperandClass()
String	getRefPtgName()
short	getRow() Returns the row number as a short, which will be wrapped (negative) for values between 32769 and 65535
int	getRowAsInt() Returns the row number as an int, between 0 and 65535
int	getSize()
boolean	isColRelative()
boolean	isRowRelative()
void	setColRelative(boolean rel)
void	setColumn(short col)
void	setColumnRaw(short col)
void	setRow(int row)
void	setRow(short row)
void	setRowRelative(boolean rel)
String	toFormulaString(Workbook book) return a string representation of this token alone
String	toString() Overridden toString method to ensure object hash is not printed.
void	writeBytes(byte[] array, int offset) write this Ptg to a byte array

Methods inherited from class loci.poi.hssf.record.formula.Ptg

createParsedExpressionTokens, createPtg, getBytes, getPtgClass, serializePtgStack, setClass, toDebugString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SIZE

private static final int SIZE

See Also:

Constant Field Values

sid

public static final byte sid

See Also:

Constant Field Values

MAX_ROW_NUMBER

private static final int MAX_ROW_NUMBER

See Also:

Constant Field Values

field_1_row

private short field_1_row

The row number, between 0 and 65535, but stored as a signed short between -32767 and 32768. Take care about which version you fetch back!

field_2_col

private short field_2_col

The column number, between 0 and ??

rowRelative

private BitField rowRelative

colRelative

private BitField colRelative

column

private BitField column

Constructor Detail

ReferencePtg

protected ReferencePtg()

ReferencePtg

public ReferencePtg(String cellref)

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

ReferencePtg

public ReferencePtg(short row,
            short column,
            boolean isRowRelative,
            boolean isColumnRelative)

ReferencePtg

public ReferencePtg(RecordInputStream in)

Creates new ValueReferencePtg

Method Detail

getRefPtgName

public String getRefPtgName()

toString

public String toString()

Description copied from class: Ptg

Overridden toString method to ensure object hash is not printed. This helps get rid of gratuitous diffs when comparing two dumps Subclasses may output more relevant information by overriding this method

Overrides:

toString in class Ptg

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

setRow

public void setRow(short row)

setRow

public void setRow(int row)

getRow

public short getRow()

Returns the row number as a short, which will be wrapped (negative) for values between 32769 and 65535

getRowAsInt

public int getRowAsInt()

Returns the row number as an int, between 0 and 65535

isRowRelative

public boolean isRowRelative()

setRowRelative

public void setRowRelative(boolean rel)

isColRelative

public boolean isColRelative()

setColRelative

public void setColRelative(boolean rel)

setColumnRaw

public void setColumnRaw(short col)

getColumnRaw

public short getColumnRaw()

setColumn

public void setColumn(short col)

getColumn

public short getColumn()

getSize

public int getSize()

Specified by:

getSize in class Ptg

toFormulaString

public String toFormulaString(Workbook 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

clone

public Object clone()

Specified by:

clone in class Ptg