org.apache.xpath.functions
Class FuncPosition

java.lang.Object
  |
  +--org.apache.xpath.Expression
        |
        +--org.apache.xpath.functions.Function
              |
              +--org.apache.xpath.functions.FuncPosition

public class FuncPosition

extends Function

**For advanced use only** Execute the Position() function.

See Also:

Serialized Form

Constructor Summary

FuncPosition()

Method Summary

XObject	execute(XPathContext xctxt) Execute the function.
int	getPositionInContextNodeList(XPathContext xctxt) Get the position in the current context node list.

Methods inherited from class org.apache.xpath.functions.Function

checkNumberArgs, setArg

Methods inherited from class org.apache.xpath.Expression

assert, canTraverseOutsideSubtree, error, setSourceLocator, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

FuncPosition

public FuncPosition()

Method Detail

getPositionInContextNodeList

public int getPositionInContextNodeList(XPathContext xctxt)

Get the position in the current context node list.

Parameters:

xctxt - Runtime XPath context.

Returns:

The current position of the itteration in the context node list, or -1 if there is no active context node list.

execute

public XObject execute(XPathContext xctxt)
                throws TransformerException

Execute the function. The function must return a valid object.

Parameters:

xctxt - The current execution context.

Returns:

A valid XObject.

Throws:

TransformerException -

Overrides:

execute in class Function