Class Index | File Index

Classes


Class xrx.xpath.FunctionCall


Extends .

Defined in: functionCall.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
A function call expression.
Field Summary
Field Attributes Field Name and Description
<static>  
xrx.xpath.FunctionCall.BuiltInFunc
An XPath function enumeration.
Method Summary
Method Attributes Method Name and Description
<static>  
xrx.xpath.FunctionCall.createFunc(name, returnType, needContextPosition, needContextNodeWithoutArgs, needContextNodeWithArgs, evaluate, minArgs, opt_maxArgs, opt_nodesetsRequired)
Constructs a Func and maps its name to it.
 
evaluate(ctx)
<static>  
xrx.xpath.FunctionCall.getFunc(name)
Returns the function object for this name.
 
Class Detail
xrx.xpath.FunctionCall(func, args)
A function call expression.
Parameters:
{!xrx.xpath.FunctionCall.BuiltInFunc} func
Function.
{!Array.} args
Arguments to the function.
Field Detail
<static> xrx.xpath.FunctionCall.BuiltInFunc
An XPath function enumeration.

A list of XPath 1.0 functions: http://www.w3.org/TR/xpath/#corelib

Method Detail
<static> {!xrx.xpath.FunctionCall.BuiltInFunc} xrx.xpath.FunctionCall.createFunc(name, returnType, needContextPosition, needContextNodeWithoutArgs, needContextNodeWithArgs, evaluate, minArgs, opt_maxArgs, opt_nodesetsRequired)
Constructs a Func and maps its name to it.
Parameters:
{string} name
Name of the function.
{xrx.xpath.DataType} returnType
Datatype of the function return value.
{boolean} needContextPosition
Whether the function needs a context position.
{boolean} needContextNodeWithoutArgs
Whether the function needs a context node when not given arguments.
{boolean} needContextNodeWithArgs
Whether the function needs a context node when the function is given arguments.
{function(!xrx.xpath.Context|...[!xrx.xpath.Expr]):*} evaluate
Evaluates the function in a context with any number of expression arguments.
{number} minArgs
Minimum number of arguments accepted by the function.
{?number=} opt_maxArgs
Maximum number of arguments accepted by the function; null means there is no max; defaults to minArgs.
{boolean=} opt_nodesetsRequired
Whether the args must be nodesets.
Returns:
{!xrx.xpath.FunctionCall.BuiltInFunc} The function created.

evaluate(ctx)
Parameters:
ctx

<static> {xrx.xpath.FunctionCall.BuiltInFunc} xrx.xpath.FunctionCall.getFunc(name)
Returns the function object for this name.
Parameters:
{string} name
The function's name.
Returns:
{xrx.xpath.FunctionCall.BuiltInFunc} The function object.

toString()

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Oct 17 2013 17:08:43 GMT+0200 (MESZ)