Apache POI - Common 5.3.0 · org.apache.poi.ss.formula.functions.Address

public Class Address

Creates a text reference as text, given specified row and column numbers.

Field Summary

Modifier and Type	Field and Description
public static final int	REF_ABSOLUTE
public static final int	REF_RELATIVE
public static final int	REF_ROW_ABSOLUTE_COLUMN_RELATIVE
public static final int	REF_ROW_RELATIVE_RELATIVE_ABSOLUTE

Constructor Summary

Access	Constructor and Description
public	Address()

Method Summary

Modifier and Type	Method and Description
public ValueEval	evaluate(ValueEval[] the evaluated function arguments. Empty values are represented with `BlankEval` or `MissingArgEval`, never `null`. args, int row index of the cell containing the formula under evaluation srcRowIndex, int column index of the cell containing the formula under evaluation srcColumnIndex) Implements org.apache.poi.ss.formula.functions.Function.evaluate.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

REF_ABSOLUTE	back to summary
public static final int REF_ABSOLUTE

REF_RELATIVE	back to summary
public static final int REF_RELATIVE

REF_ROW_ABSOLUTE_COLUMN_RELATIVE	back to summary
public static final int REF_ROW_ABSOLUTE_COLUMN_RELATIVE

REF_ROW_RELATIVE_RELATIVE_ABSOLUTE	back to summary
public static final int REF_ROW_RELATIVE_RELATIVE_ABSOLUTE

Constructor Detail

Address	back to summary
public Address()

Method Detail

evaluate back to summary

evaluate	back to summary
public ValueEval evaluate(ValueEval[] args, int srcRowIndex, int srcColumnIndex) Implements org.apache.poi.ss.formula.functions.Function.evaluate. Parameters args:ValueEval[] Doc from org.apache.poi.ss.formula.functions.Function.evaluate. the evaluated function arguments. Empty values are represented with `BlankEval` or `MissingArgEval`, never `null`. srcRowIndex:int Doc from org.apache.poi.ss.formula.functions.Function.evaluate. row index of the cell containing the formula under evaluation srcColumnIndex:int Doc from org.apache.poi.ss.formula.functions.Function.evaluate. column index of the cell containing the formula under evaluation Returns:ValueEval Doc from org.apache.poi.ss.formula.functions.Function.evaluate. The evaluated result, possibly an `ErrorEval`, never `null` Note - Excel uses the error code #NUM! instead of IEEE NaN, so when numeric functions evaluate to `Double#NaN` be sure to translate the result to `ErrorEval#NUM_ERROR`.

public ValueEval evaluate(ValueEval[] args, int srcRowIndex, int srcColumnIndex)

Implements org.apache.poi.ss.formula.functions.Function.evaluate.

Parameters

args:ValueEval[]

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval, never null.

srcRowIndex:int

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

row index of the cell containing the formula under evaluation

srcColumnIndex:int

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

column index of the cell containing the formula under evaluation

Returns:ValueEval

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

The evaluated result, possibly an ErrorEval, never null

Note

- Excel uses the error code #NUM! instead of IEEE NaN, so when numeric functions evaluate to Double#NaN be sure to translate the result to ErrorEval#NUM_ERROR.