org.apache.xpath.functions
Class FuncSubstring

java.lang.Object
  extended by org.apache.xpath.Expression
      extended by org.apache.xpath.functions.Function
          extended by org.apache.xpath.functions.FunctionOneArg
              extended by org.apache.xpath.functions.Function2Args
                  extended by org.apache.xpath.functions.Function3Args
                      extended by org.apache.xpath.functions.FuncSubstring
All Implemented Interfaces:
java.io.Serializable, javax.xml.transform.SourceLocator, ExpressionNode, ExpressionOwner, XPathVisitable

public class FuncSubstring
extends Function3Args

Execute the Substring() function.

See Also:
Serialized Form
Usage:
**For advanced use only**

Constructor Summary
FuncSubstring()
           
 
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.
 
Methods inherited from class org.apache.xpath.functions.Function3Args
callArgVisitors, canTraverseOutsideSubtree, deepEquals, fixupVariables, getArg2, setArg
 
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, isStableNumber, num, warn, xstr
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FuncSubstring

public FuncSubstring()
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 Function3Args
Parameters:
argNum - The number of arguments that is being passed to the function.
Throws:
WrongNumberArgsException


Copyright © 2005 Apache XML Project. All Rights Reserved.