org.expath.tools.saxon.fun

Class Parameters

java.lang.Object

org.expath.tools.saxon.fun.Parameters

public class Parameters
extends java.lang.Object

Utilities for extension functions parameters for Saxon.

Author:

Florent Georges

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Parameters.Formatter

Constructor Summary

Constructors

Constructor and Description
Parameters(Library lib, net.sf.saxon.om.Sequence[] params, int min, Param[] formals) Check the number of parameters in params, and throw an error if not OK.

Method Summary

Modifier and Type	Method and Description
byte[]	asBinary(int pos, boolean optional) Return the pos-th parameter, checking it is a base64 binary.
java.lang.Boolean	asBoolean(int pos, boolean optional) Return the pos-th parameter, checking it is a boolean.
org.expath.tools.model.Element	asElement(int pos, boolean optional, net.sf.saxon.expr.XPathContext ctxt) Return the pos-th parameter, checking it is an element node.
org.expath.tools.model.Element	asElement(int pos, boolean optional, net.sf.saxon.expr.XPathContext ctxt, java.lang.String name) Return the pos-th parameter, checking it is an element node, as well as its name.
java.lang.Long	asLong(int pos, boolean optional) Return the pos-th parameter, checking it is a string.
org.expath.tools.model.Sequence	asSequence(int pos, boolean optional, net.sf.saxon.expr.XPathContext ctxt) Return the pos-th parameter, as a sequence.
java.lang.String	asString(int pos, boolean optional) Return the pos-th parameter, checking it is a string.
java.util.List<java.lang.String>	asStringList(int pos, boolean optional) Return the pos-th parameter, checking it is a list of strings.
Parameters.Formatter	format(java.lang.String name)
int	number() Return the number of parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameters

public Parameters(Library lib,
                  net.sf.saxon.om.Sequence[] params,
                  int min,
                  Param[] formals)
           throws net.sf.saxon.trans.XPathException

Check the number of parameters in params, and throw an error if not OK.

Parameters:

lib - The extension library.

params - The parameter list.

min - The minimal number of parameters.

formals - The formal parameters.

Throws:

net.sf.saxon.trans.XPathException - If there is not exactly num parameters.

Method Detail

number

public int number()

Return the number of parameters.

Returns:

The number of parameters.

asString

public java.lang.String asString(int pos,
                                 boolean optional)
                          throws net.sf.saxon.trans.XPathException

Return the pos-th parameter, checking it is a string. If optional is false and the parameter is the empty sequence, an XPathException is thrown. As well as if there is more than one item.

Parameters:

pos - The position of the parameter to analyze, 0-based.

optional - Can the parameter be the empty sequence?

Returns:

The parameter as a string.

Throws:

net.sf.saxon.trans.XPathException - If there is not such parameter or if it is not a string.

asBoolean

public java.lang.Boolean asBoolean(int pos,
                                   boolean optional)
                            throws net.sf.saxon.trans.XPathException

Return the pos-th parameter, checking it is a boolean. If optional is false and the parameter is the empty sequence, an XPathException is thrown. As well as if there is more than one item.

Parameters:

pos - The position of the parameter to analyze, 0-based.

optional - Can the parameter be the empty sequence?

Returns:

The parameter as a boolean.

Throws:

net.sf.saxon.trans.XPathException - If there is not such parameter or if it is not a boolean.

asLong

public java.lang.Long asLong(int pos,
                             boolean optional)
                      throws net.sf.saxon.trans.XPathException

Return the pos-th parameter, checking it is a string. If optional is false and the parameter is the empty sequence, an XPathException is thrown. As well as if there is more than one item.

Parameters:

pos - The position of the parameter to analyze, 0-based.

optional - Can the parameter be the empty sequence?

Returns:

The parameter as a long.

Throws:

net.sf.saxon.trans.XPathException - If there is not such parameter or if it is not a long.

asStringList

public java.util.List<java.lang.String> asStringList(int pos,
                                                     boolean optional)
                                              throws net.sf.saxon.trans.XPathException

Return the pos-th parameter, checking it is a list of strings. If optional is false and the parameter is the empty sequence, an XPathException is thrown.

Parameters:

pos - The position of the parameter to analyze, 0-based.

optional - Can the parameter be the empty sequence?

Returns:

The parameter as a string sequence.

Throws:

net.sf.saxon.trans.XPathException - If there is not such parameter or if it is not a string sequence.

asBinary

public byte[] asBinary(int pos,
                       boolean optional)
                throws net.sf.saxon.trans.XPathException

Return the pos-th parameter, checking it is a base64 binary. If optional is false and the parameter is the empty sequence, an XPathException is thrown. As well as if there is more than one item.

Parameters:

pos - The position of the parameter to analyze, 0-based.

optional - Can the parameter be the empty sequence?

Returns:

The parameter as a binary.

Throws:

net.sf.saxon.trans.XPathException - If there is not such parameter or if it is not a binary.

asElement

public org.expath.tools.model.Element asElement(int pos,
                                                boolean optional,
                                                net.sf.saxon.expr.XPathContext ctxt)
                                         throws net.sf.saxon.trans.XPathException

Return the pos-th parameter, checking it is an element node. If optional is false and the parameter is the empty sequence, an XPathException is thrown. As well as if there is more than one item, or if the param is not an element node.

Parameters:

pos - The position of the parameter to analyze, 0-based.

optional - Can the parameter be the empty sequence?

ctxt - The context in which this extension call occurs.

Returns:

The parameter as an element.

Throws:

net.sf.saxon.trans.XPathException - If there is not such parameter or if it is not an element.

asElement

public org.expath.tools.model.Element asElement(int pos,
                                                boolean optional,
                                                net.sf.saxon.expr.XPathContext ctxt,
                                                java.lang.String name)
                                         throws net.sf.saxon.trans.XPathException

Return the pos-th parameter, checking it is an element node, as well as its name. If optional is false and the parameter is the empty sequence, an XPathException is thrown. As well as if there is more than one item, or if the param is not an element node, or if the element name is not equal to name (in the webapp namespace).

Parameters:

pos - The position of the parameter to analyze, 0-based.

optional - Can the parameter be the empty sequence?

ctxt - The context in which this extension call occurs.

name - The required local name of the element.

Returns:

The parameter as an element.

Throws:

net.sf.saxon.trans.XPathException - If there is not such parameter or if it is not an element.

asSequence

public org.expath.tools.model.Sequence asSequence(int pos,
                                                  boolean optional,
                                                  net.sf.saxon.expr.XPathContext ctxt)
                                           throws net.sf.saxon.trans.XPathException

Return the pos-th parameter, as a sequence. If optional is false and the parameter is the empty sequence, an XPathException is thrown.

Parameters:

pos - The position of the parameter to analyze, 0-based.

optional - Can the parameter be the empty sequence?

ctxt - The context in which this extension call occurs.

Returns:

The parameter as a sequence (never return null).

Throws:

net.sf.saxon.trans.XPathException - If there is not such parameter or if it is not an element.

format

public Parameters.Formatter format(java.lang.String name)