org.zkoss.poi.ss.formula.eval

Class ErrorEval

java.lang.Object

org.zkoss.poi.ss.formula.eval.ErrorEval

All Implemented Interfaces:

HyperlinkEval, ValueEval

public final class ErrorEval
extends java.lang.Object
implements ValueEval, HyperlinkEval

Author:

Amol S. Deshmukh < amolweb at ya hoo dot com >, henrichen@zkoss.org: HYPERLINK function

Field Summary

Fields

Modifier and Type	Field and Description
static ErrorEval	CIRCULAR_REF_ERROR
static ErrorEval	DIV_ZERO #DIV/0!
static ErrorEval	FORMULA_INVALID
static ErrorEval	NA #N/A - Argument or function not available
static ErrorEval	NAME_INVALID #NAME?
static ErrorEval	NULL_INTERSECTION #NULL!
static ErrorEval	NUM_ERROR #NUM!
static ErrorEval	REF_INVALID #REF!
static ErrorEval	VALUE_INVALID #VALUE!

Method Summary

Modifier and Type	Method and Description
int	getErrorCode()
Hyperlink	getHyperlink() Returns the associated hyperlink if this ValueEval is a label of the HYPERLINK function.
static java.lang.String	getText(int errorCode) Converts error codes to text.
static java.lang.String	getTooltip(int errorCode)
void	setHyperlink(Hyperlink hyperlink) Sets the associated hyperlink if this ValueEval is a label of the HYPERLINK function.
java.lang.String	toString()
static ErrorEval	valueOf(int errorCode) Translates an Excel internal error code into the corresponding POI ErrorEval instance

Methods inherited from class java.lang.Object

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

Field Detail

NULL_INTERSECTION

public static final ErrorEval NULL_INTERSECTION

#NULL! - Intersection of two cell ranges is empty

DIV_ZERO

public static final ErrorEval DIV_ZERO

#DIV/0! - Division by zero

VALUE_INVALID

public static final ErrorEval VALUE_INVALID

#VALUE! - Wrong type of operand

REF_INVALID

public static final ErrorEval REF_INVALID

#REF! - Illegal or deleted cell reference

NAME_INVALID

public static final ErrorEval NAME_INVALID

#NAME? - Wrong function or range name

NUM_ERROR

public static final ErrorEval NUM_ERROR

#NUM! - Value range overflow

NA

public static final ErrorEval NA

#N/A - Argument or function not available

FORMULA_INVALID

public static final ErrorEval FORMULA_INVALID

CIRCULAR_REF_ERROR

public static final ErrorEval CIRCULAR_REF_ERROR

Method Detail

valueOf

public static ErrorEval valueOf(int errorCode)

Translates an Excel internal error code into the corresponding POI ErrorEval instance

Parameters:

errorCode -

getText

public static java.lang.String getText(int errorCode)

Converts error codes to text. Handles non-standard error codes OK. For debug/test purposes (and for formatting error messages).

Returns:

the String representation of the specified Excel error code.

getErrorCode

public int getErrorCode()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setHyperlink

public void setHyperlink(Hyperlink hyperlink)

Description copied from interface: HyperlinkEval

Sets the associated hyperlink if this ValueEval is a label of the HYPERLINK function.

Specified by:

setHyperlink in interface HyperlinkEval

Parameters:

hyperlink - the associated hyperlink

getHyperlink

public Hyperlink getHyperlink()

Description copied from interface: HyperlinkEval

Returns the associated hyperlink if this ValueEval is a label of the HYPERLINK function.

Specified by:

getHyperlink in interface HyperlinkEval

Returns:

the associated hyperlink.

getTooltip

public static java.lang.String getTooltip(int errorCode)