org.apache.xpath.functions

Class FuncSubstring

Implemented Interfaces:
ExpressionNode, ExpressionOwner, java.io.Serializable, SourceLocator, XPathVisitable

public class FuncSubstring
extends Function3Args

Execute the Substring() function.
See Also:
Serialized Form

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, checkNumberArgs, deepEquals, fixupVariables, getArg2, setArg

Methods inherited from class org.apache.xpath.functions.Function2Args

callArgVisitors, canTraverseOutsideSubtree, checkNumberArgs, deepEquals, fixupVariables, getArg1, setArg

Methods inherited from class org.apache.xpath.functions.FunctionOneArg

callArgVisitors, canTraverseOutsideSubtree, checkNumberArgs, deepEquals, fixupVariables, getArg0, getExpression, setArg, setExpression

Methods inherited from class org.apache.xpath.functions.Function

callArgVisitors, callVisitors, checkNumberArgs, deepEquals, execute, postCompileStep, setArg

Methods inherited from class org.apache.xpath.Expression

asIterator, asIteratorRaw, asNode, assertion, bool, canTraverseOutsideSubtree, deepEquals, error, execute, execute, execute, execute, executeCharsToContentHandler, exprAddChild, exprGetChild, exprGetNumChildren, exprGetParent, exprSetParent, fixupVariables, getColumnNumber, getExpressionOwner, getLineNumber, getPublicId, getSystemId, isNodesetExpr, isStableNumber, num, warn, xstr

Method Details

checkNumberArgs

public void checkNumberArgs(int argNum)
            throws WrongNumberArgsException
Check that the number of arguments passed to this function is correct.
Overrides:
checkNumberArgs in interface Function3Args
Parameters:
argNum - The number of arguments that is being passed to the function.

execute

public XObject execute(XPathContext xctxt)
            throws TransformerException
Execute the function. The function must return a valid object.
Overrides:
execute in interface Function
Parameters:
xctxt - The current execution context.
Returns:
A valid XObject.

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