org.apache.xpath.functions
Class FunctionOneArg

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

Direct Known Subclasses:

FuncBoolean, FuncCeiling, FuncCount, FuncExtElementAvailable, FuncExtFunctionAvailable, FuncFloor, FuncId, FuncLang, FuncNot, FuncRound, FuncSum, FuncSystemProperty, Function2Args, FunctionDef1Arg, FuncUnparsedEntityURI

public class FunctionOneArg

extends Function

implements ExpressionOwner

Base class for functions that accept one argument.

See Also:

Serialized Form

Usage:

**For advanced use only**

Constructor Summary

FunctionOneArg()

Method Summary

void	callArgVisitors(XPathVisitor visitor)
boolean	canTraverseOutsideSubtree() Tell if this expression or it's subexpressions can traverse outside the current subtree.
void	checkNumberArgs(int argNum) Check that the number of arguments passed to this function is correct.
boolean	deepEquals(Expression expr)
void	fixupVariables(java.util.Vector vars, int globalsSize) This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.
Expression	getArg0() Return the first argument passed to the function (at index 0).
Expression	getExpression()
void	setArg(Expression arg, int argNum) Set an argument expression for a function.
void	setExpression(Expression exp)

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

callVisitors, execute, postCompileStep

Methods inherited from class org.apache.xpath.Expression

asIterator, asIteratorRaw, asNode, assertion, bool, error, execute, execute, execute, executeCharsToContentHandler, exprAddChild, exprGetChild, exprGetNumChildren, exprGetParent, exprSetParent, getColumnNumber, getExpressionOwner, getLineNumber, getPublicId, getSystemId, isNodesetExpr, isStableNumber, num, warn, xstr

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionOneArg

public FunctionOneArg()

Method Detail

getArg0

public Expression getArg0()

Return the first argument passed to the function (at index 0).

Returns:

An expression that represents the first argument passed to the function.

setArg

public void setArg(Expression arg,
                   int argNum)
            throws WrongNumberArgsException

Set an argument expression for a function. This method is called by the XPath compiler.

Parameters:

arg - non-null expression that represents the argument.

argNum - The argument number index.

Throws:

WrongNumberArgsException - If the argNum parameter is greater than 0.

Overrides:

setArg in class Function

checkNumberArgs

public void checkNumberArgs(int argNum)
                     throws WrongNumberArgsException

Check that the number of arguments passed to this function is correct.

Parameters:

argNum - The number of arguments that is being passed to the function.

Throws:

WrongNumberArgsException -

Overrides:

checkNumberArgs in class Function

canTraverseOutsideSubtree

public boolean canTraverseOutsideSubtree()

Tell if this expression or it's subexpressions can traverse outside the current subtree.

Returns:

true if traversal outside the context node's subtree can occur.

Overrides:

canTraverseOutsideSubtree in class Expression

fixupVariables

public void fixupVariables(java.util.Vector vars,
                           int globalsSize)

This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.

Parameters:

vars - List of QNames that correspond to variables. This list should be searched backwards for the first qualified name that corresponds to the variable reference qname. The position of the QName in the vector from the start of the vector will be its position in the stack frame (but variables above the globalsTop value will need to be offset to the current stack frame).

Overrides:

fixupVariables in class Expression

callArgVisitors

public void callArgVisitors(XPathVisitor visitor)

Overrides:

callArgVisitors in class Function

See Also:

XPathVisitable.callVisitors(ExpressionOwner, XPathVisitor)

getExpression

public Expression getExpression()

Specified by:

getExpression in interface ExpressionOwner

See Also:

ExpressionOwner.getExpression()

setExpression

public void setExpression(Expression exp)

Specified by:

setExpression in interface ExpressionOwner

See Also:

ExpressionOwner.setExpression(Expression)

deepEquals

public boolean deepEquals(Expression expr)

Overrides:

deepEquals in class Function

See Also:

Expression.deepEquals(Expression)