org.apache.xalan.templates

Class FuncDocument

public class FuncDocument extends Function2Args

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.

UNKNOWN: advanced

Method Summary
voidcheckNumberArgs(int argNum)
Overide the superclass method to allow one or two arguments.
voiderror(XPathContext xctxt, String msg, Object[] args)
Tell the user of an error, and probably throw an exception.
XObjectexecute(XPathContext xctxt)
Execute the function.
booleanisNodesetExpr()
Tell if the expression is a nodeset expression.
voidwarn(XPathContext xctxt, String msg, Object[] args)
Warn the user of a problem.

Method Detail

checkNumberArgs

public void checkNumberArgs(int argNum)
Overide the superclass method to allow one or two arguments.

Parameters: argNum Number of arguments passed in to this function

Throws: WrongNumberArgsException

error

public void error(XPathContext xctxt, String msg, Object[] args)
Tell the user of an error, and probably throw an exception.

Parameters: xctxt The XPath runtime state. msg The error message key args Arguments to be used in the error message

Throws: XSLProcessorException thrown if the active ProblemListener and XPathContext decide the error condition is severe enough to halt processing. javax.xml.transform.TransformerException

execute

public XObject execute(XPathContext xctxt)
Execute the function. The function must return a valid object.

Parameters: xctxt The current execution context.

Returns: A valid XObject.

Throws: javax.xml.transform.TransformerException

isNodesetExpr

public boolean isNodesetExpr()
Tell if the expression is a nodeset expression.

Returns: true if the expression can be represented as a nodeset.

warn

public void warn(XPathContext xctxt, String msg, Object[] args)
Warn the user of a problem.

Parameters: xctxt The XPath runtime state. msg Warning message key args Arguments to be used in the warning message

Throws: XSLProcessorException thrown if the active ProblemListener and XPathContext decide the error condition is severe enough to halt processing. javax.xml.transform.TransformerException

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