org.apache.xpath.functions
Class FuncConcat

java.lang.Object
  extended byorg.apache.xpath.Expression
      extended byorg.apache.xpath.functions.Function
          extended byorg.apache.xpath.functions.FunctionOneArg
              extended byorg.apache.xpath.functions.Function2Args
                  extended byorg.apache.xpath.functions.Function3Args
                      extended byorg.apache.xpath.functions.FunctionMultiArgs
                          extended byorg.apache.xpath.functions.FuncConcat
All Implemented Interfaces:
ExpressionNode, ExpressionOwner, Serializable, javax.xml.transform.SourceLocator, XPathVisitable

public class FuncConcat
extends FunctionMultiArgs

Execute the Concat() function.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class org.apache.xpath.functions.FunctionMultiArgs
FunctionMultiArgs.ArgMultiOwner
 
Nested classes inherited from class org.apache.xpath.functions.Function3Args
Function3Args.Arg2Owner
 
Nested classes inherited from class org.apache.xpath.functions.Function2Args
Function2Args.Arg1Owner
 
Field Summary
 
Fields inherited from class org.apache.xpath.functions.FunctionMultiArgs
m_args
 
Fields inherited from class org.apache.xpath.functions.Function3Args
m_arg2
 
Fields inherited from class org.apache.xpath.functions.Function2Args
m_arg1
 
Fields inherited from class org.apache.xpath.functions.FunctionOneArg
m_arg0
 
Fields inherited from class org.apache.xpath.Expression
 
Constructor Summary
FuncConcat()
           
 
Method Summary
 void checkNumberArgs(int argNum)
          Check that the number of arguments passed to this function is correct.
 XObject execute(XPathContext xctxt)
          Execute the function.
protected  void reportWrongNumberArgs()
          Constructs and throws a WrongNumberArgException with the appropriate message for this function object.
 
Methods inherited from class org.apache.xpath.functions.FunctionMultiArgs
callArgVisitors, canTraverseOutsideSubtree, deepEquals, fixupVariables, getArgs, setArg
 
Methods inherited from class org.apache.xpath.functions.Function3Args
getArg2
 
Methods inherited from class org.apache.xpath.functions.Function2Args
getArg1
 
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, error, execute, execute, execute, executeCharsToContentHandler, exprAddChild, exprGetChild, exprGetNumChildren, exprGetParent, exprSetParent, getColumnNumber, getExpressionOwner, getLineNumber, getPublicId, getSystemId, isNodesetExpr, isSameClass, isStableNumber, num, warn, xstr
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FuncConcat

public FuncConcat()
Method Detail

execute

public XObject execute(XPathContext xctxt)
                throws javax.xml.transform.TransformerException
Execute the function. The function must return a valid object.

Overrides:
execute in class Function
Parameters:
xctxt - The current execution context.
Returns:
A valid XObject.
Throws:
javax.xml.transform.TransformerException

checkNumberArgs

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

Overrides:
checkNumberArgs in class FunctionMultiArgs
Parameters:
argNum - The number of arguments that is being passed to the function.
Throws:
WrongNumberArgsException

reportWrongNumberArgs

protected void reportWrongNumberArgs()
                              throws WrongNumberArgsException
Constructs and throws a WrongNumberArgException with the appropriate message for this function object.

Overrides:
reportWrongNumberArgs in class FunctionMultiArgs
Throws:
WrongNumberArgsException