org.apache.xpath.functions

Class FunctionDef1Arg

Implemented Interfaces:
ExpressionNode, ExpressionOwner, java.io.Serializable, SourceLocator, XPathVisitable
Known Direct Subclasses:
FuncDoclocation, FuncGenerateId, FuncLocalPart, FuncNamespace, FuncNormalizeSpace, FuncNumber, FuncQname, FuncString, FuncStringLength

public class FunctionDef1Arg
extends FunctionOneArg

Base class for functions that accept one argument that can be defaulted if not specified.
See Also:
Serialized Form

Method Summary

boolean
Arg0IsNodesetExpr()
Tell if the expression is a nodeset expression.
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.

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

Arg0IsNodesetExpr

public boolean Arg0IsNodesetExpr()
Tell if the expression is a nodeset expression.
Returns:
true if the expression can be represented as a nodeset.

canTraverseOutsideSubtree

public boolean canTraverseOutsideSubtree()
Tell if this expression or it's subexpressions can traverse outside the current subtree.
Overrides:
canTraverseOutsideSubtree in interface FunctionOneArg
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 FunctionOneArg
Parameters:
argNum - The number of arguments that is being passed to the function.
Throws:
WrongNumberArgsException - if the number of arguments is not 0 or 1.

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