org.apache.xpath.functions

Class Function2Args

public class Function2Args extends FunctionOneArg

Base class for functions that accept two arguments.

UNKNOWN: advanced

Method Summary
voidcallArgVisitors(XPathVisitor visitor)
booleancanTraverseOutsideSubtree()
Tell if this expression or it's subexpressions can traverse outside the current subtree.
voidcheckNumberArgs(int argNum)
Check that the number of arguments passed to this function is correct.
booleandeepEquals(Expression expr)
voidfixupVariables(Vector vars, int globalsSize)
This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.
ExpressiongetArg1()
Return the second argument passed to the function (at index 1).
voidsetArg(Expression arg, int argNum)
Set an argument expression for a function.

Method Detail

callArgVisitors

public void callArgVisitors(XPathVisitor visitor)

See Also: XPathVisitable

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.

checkNumberArgs

public void checkNumberArgs(int argNum)
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

deepEquals

public boolean deepEquals(Expression expr)

See Also: deepEquals

fixupVariables

public void fixupVariables(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).

getArg1

public Expression getArg1()
Return the second argument passed to the function (at index 1).

Returns: An expression that represents the second argument passed to the function.

setArg

public void setArg(Expression arg, int argNum)
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 1.

Copyright © 2005 Apache XML Project. All Rights Reserved.