org.apache.xpath.functions

Class Function3Args

Implemented Interfaces:
ExpressionNode, ExpressionOwner, java.io.Serializable, SourceLocator, XPathVisitable
Known Direct Subclasses:
FuncFormatNumb, FuncSubstring, FunctionMultiArgs, FuncTranslate

public class Function3Args
extends Function2Args

Base class for functions that accept three arguments.

See Also:
Serialized Form

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
getArg2()
Return the third argument passed to the function (at index 2).
void
setArg(Expression arg, int argNum)
Set an argument expression for a function.

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

callArgVisitors, canTraverseOutsideSubtree, checkNumberArgs, deepEquals, fixupVariables, getArg1, setArg

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

callArgVisitors, canTraverseOutsideSubtree, checkNumberArgs, deepEquals, fixupVariables, getArg0, getExpression, setArg, setExpression

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

callArgVisitors, callVisitors, checkNumberArgs, deepEquals, execute, postCompileStep, setArg

Methods inherited from class org.apache.xpath.Expression

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

Method Details

callArgVisitors

public void callArgVisitors(XPathVisitor visitor)
Overrides:
callArgVisitors in interface Function2Args

See Also:
XPathVisitable.callVisitors(ExpressionOwner, XPathVisitor)


canTraverseOutsideSubtree

public boolean canTraverseOutsideSubtree()
Tell if this expression or it's subexpressions can traverse outside the current subtree.
Overrides:
canTraverseOutsideSubtree in interface Function2Args

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


checkNumberArgs

public void checkNumberArgs(int argNum)
            throws WrongNumberArgsException
Check that the number of arguments passed to this function is correct.
Overrides:
checkNumberArgs in interface Function2Args

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

Throws:
WrongNumberArgsException -


deepEquals

public boolean deepEquals(Expression expr)
Overrides:
deepEquals in interface Function2Args

See Also:
Expression.deepEquals(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.
Overrides:
fixupVariables in interface Function2Args

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).


getArg2

public Expression getArg2()
Return the third argument passed to the function (at index 2).

Returns:
An expression that represents the third 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.
Overrides:
setArg in interface Function2Args

Parameters:
arg - non-null expression that represents the argument.
argNum - The argument number index.

Throws:
WrongNumberArgsException - If the argNum parameter is greater than 2.


Copyright B) 2004 Apache XML Project. All Rights Reserved.