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

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.xpath.functions.Function3Args
Function3Args.Arg2Owner
 
Nested classes/interfaces inherited from class org.apache.xpath.functions.Function2Args
Function2Args.Arg1Owner
 
Field Summary
(package private) static long serialVersionUID
           
 
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
 
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.
protected  void reportWrongNumberArgs()
          Constructs and throws a WrongNumberArgException with the appropriate message for this function object.
 
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, isSameClass, isStableNumber, num, warn, xstr
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values
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

reportWrongNumberArgs

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

Overrides:
reportWrongNumberArgs in class Function3Args
Throws:
WrongNumberArgsException