org.apache.poi.hssf.record.formula.functions
Class Hyperlink

java.lang.Object
  extended by org.apache.poi.hssf.record.formula.functions.Hyperlink
All Implemented Interfaces:
Function

public final class Hyperlink
extends java.lang.Object
implements Function

Implementation of Excel HYPERLINK function.

In Excel this function has special behaviour - it causes the displayed cell value to behave like a hyperlink in the GUI. From an evaluation perspective however, it is very simple.

Syntax:
HYPERLINK(link_location, friendly_name)

link_location The URL of the hyperlink
friendly_name (optional) the value to display

Returns last argument. Leaves type unchanged (does not convert to StringEval).

Author:
Wayne Clingingsmith

Constructor Summary
Hyperlink()
           
 
Method Summary
 Eval evaluate(Eval[] operands, int srcRow, short srcCol)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Hyperlink

public Hyperlink()
Method Detail

evaluate

public Eval evaluate(Eval[] operands,
                     int srcRow,
                     short srcCol)
Specified by:
evaluate in interface Function
Parameters:
operands - the evaluated function arguments. Elements of this array typically implement ValueEval. Empty values are represented with BlankEval or MissingArgEval, never null.
srcRow - row index of the cell containing the formula under evaluation
srcCol - column index of the cell containing the formula under evaluation
Returns:
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.


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