Package org.apache.xpath.functions
Class FunctionOneArg
java.lang.Object
org.apache.xpath.Expression
org.apache.xpath.functions.Function
org.apache.xpath.functions.FunctionOneArg
- All Implemented Interfaces:
Serializable
,SourceLocator
,ExpressionNode
,ExpressionOwner
,XPathVisitable
- Direct Known Subclasses:
FuncBoolean
,FuncCeiling
,FuncCount
,FuncExtElementAvailable
,FuncExtFunctionAvailable
,FuncFloor
,FuncId
,FuncLang
,FuncNot
,FuncRound
,FuncSum
,FuncSystemProperty
,Function2Args
,FunctionDef1Arg
,FuncUnparsedEntityURI
Base class for functions that accept one argument.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
callArgVisitors
(XPathVisitor visitor) Call the visitors for the function arguments.boolean
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) Compare this object with another object and see if they are equal, include the sub heararchy.void
fixupVariables
(Vector vars, int globalsSize) This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.getArg0()
Return the first argument passed to the function (at index 0).Get the raw Expression object that this class wraps.void
setArg
(Expression arg, int argNum) Set an argument expression for a function.void
setExpression
(Expression exp) Set the raw expression object for this object.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
-
Constructor Details
-
FunctionOneArg
public FunctionOneArg()
-
-
Method Details
-
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
Set an argument expression for a function. This method is called by the XPath compiler.- Overrides:
setArg
in classFunction
- Parameters:
arg
- non-null expression that represents the argument.argNum
- The argument number index.- Throws:
WrongNumberArgsException
- If the argNum parameter is greater than 0.
-
checkNumberArgs
Check that the number of arguments passed to this function is correct.- Overrides:
checkNumberArgs
in classFunction
- Parameters:
argNum
- The number of arguments that is being passed to the function.- Throws:
WrongNumberArgsException
-
canTraverseOutsideSubtree
public boolean canTraverseOutsideSubtree()Tell if this expression or it's subexpressions can traverse outside the current subtree.- Overrides:
canTraverseOutsideSubtree
in classExpression
- Returns:
- true if traversal outside the context node's subtree can occur.
-
fixupVariables
This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.- Specified by:
fixupVariables
in classExpression
- 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).
-
callArgVisitors
Description copied from class:Function
Call the visitors for the function arguments.- Overrides:
callArgVisitors
in classFunction
- See Also:
-
getExpression
Description copied from interface:ExpressionOwner
Get the raw Expression object that this class wraps.- Specified by:
getExpression
in interfaceExpressionOwner
- Returns:
- the raw Expression object, which should not normally be null.
- See Also:
-
setExpression
Description copied from interface:ExpressionOwner
Set the raw expression object for this object.- Specified by:
setExpression
in interfaceExpressionOwner
- Parameters:
exp
- the raw Expression object, which should not normally be null.- See Also:
-
deepEquals
Description copied from class:Expression
Compare this object with another object and see if they are equal, include the sub heararchy.- Overrides:
deepEquals
in classFunction
- Parameters:
expr
- Another expression object.- Returns:
- true if this objects class and the expr object's class are the same, and the data contained within both objects are considered equal.
- See Also:
-