Package org.apache.xalan.templates
Class FuncDocument
java.lang.Object
org.apache.xpath.Expression
org.apache.xpath.functions.Function
org.apache.xpath.functions.FunctionOneArg
org.apache.xpath.functions.Function2Args
org.apache.xalan.templates.FuncDocument
- All Implemented Interfaces:
Serializable
,SourceLocator
,ExpressionNode
,ExpressionOwner
,XPathVisitable
Execute the Doc() function.
When the document function has exactly one argument and the argument
is a node-set, then the result is the union, for each node in the
argument node-set, of the result of calling the document function with
the first argument being the string-value of the node, and the second
argument being a node-set with the node as its only member. When the
document function has two arguments and the first argument is a node-set,
then the result is the union, for each node in the argument node-set,
of the result of calling the document function with the first argument
being the string-value of the node, and with the second argument being
the second argument passed to the document function.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
checkNumberArgs
(int argNum) Overide the superclass method to allow one or two arguments.void
error
(XPathContext xctxt, String msg, Object[] args) Tell the user of an error, and probably throw an exception.execute
(XPathContext xctxt) Execute the function.boolean
Tell if the expression is a nodeset expression.void
warn
(XPathContext xctxt, String msg, Object[] args) Warn the user of a problem.Methods inherited from class org.apache.xpath.functions.Function2Args
callArgVisitors, canTraverseOutsideSubtree, deepEquals, fixupVariables, getArg1, setArg
Methods inherited from class org.apache.xpath.functions.FunctionOneArg
getArg0, getExpression, setExpression
Methods inherited from class org.apache.xpath.functions.Function
callVisitors, postCompileStep
Methods inherited from class org.apache.xpath.Expression
asIterator, asIteratorRaw, asNode, assertion, bool, execute, execute, execute, executeCharsToContentHandler, exprAddChild, exprGetChild, exprGetNumChildren, exprGetParent, exprSetParent, getColumnNumber, getExpressionOwner, getLineNumber, getPublicId, getSystemId, isStableNumber, num, xstr
-
Constructor Details
-
FuncDocument
public FuncDocument()
-
-
Method Details
-
execute
Execute the function. The function must return a valid object.- Overrides:
execute
in classFunction
- Parameters:
xctxt
- The current execution context.- Returns:
- A valid XObject.
- Throws:
TransformerException
-
error
Tell the user of an error, and probably throw an exception.- Overrides:
error
in classExpression
- Parameters:
xctxt
- The XPath runtime state.msg
- The error message keyargs
- Arguments to be used in the error message
-
warn
Warn the user of a problem.- Overrides:
warn
in classExpression
- Parameters:
xctxt
- The XPath runtime state.msg
- Warning message keyargs
- Arguments to be used in the warning message
-
checkNumberArgs
Overide the superclass method to allow one or two arguments.- Overrides:
checkNumberArgs
in classFunction2Args
- Parameters:
argNum
- Number of arguments passed in to this function- Throws:
WrongNumberArgsException
-
isNodesetExpr
public boolean isNodesetExpr()Tell if the expression is a nodeset expression.- Overrides:
isNodesetExpr
in classExpression
- Returns:
- true if the expression can be represented as a nodeset.
-