Package net.sf.saxon.functions
Class Substring
- java.lang.Object
-
- net.sf.saxon.expr.Expression
-
- net.sf.saxon.expr.FunctionCall
-
- net.sf.saxon.functions.SystemFunction
-
- net.sf.saxon.functions.Substring
-
- All Implemented Interfaces:
java.io.Serializable
,javax.xml.transform.SourceLocator
,LocationProvider
,SaxonLocator
,EvaluableItem
,SequenceIterable
,InstructionInfo
,org.xml.sax.Locator
public class Substring extends SystemFunction
This class implements the XPath substring() function- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class net.sf.saxon.functions.SystemFunction
operation
-
Fields inherited from class net.sf.saxon.expr.FunctionCall
argument
-
Fields inherited from class net.sf.saxon.expr.Expression
EVALUATE_METHOD, ITERATE_METHOD, locationId, PROCESS_METHOD, staticProperties
-
-
Constructor Summary
Constructors Constructor Description Substring()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Item
evaluateItem(XPathContext context)
Evaluate the functionstatic java.lang.CharSequence
substring(StringValue sv, NumericValue start)
Implement the substring function with two arguments.static java.lang.CharSequence
substring(StringValue sv, NumericValue start, NumericValue len, XPathContext context)
Implement the substring function with three arguments.-
Methods inherited from class net.sf.saxon.functions.SystemFunction
addContextDocumentArgument, addDocToPathMap, checkArguments, computeCardinality, computeSpecialProperties, copy, getDetails, getErrorCodeForTypeErrors, getItemType, getRequiredType, makeSystemFunction, optimize, setDetails, useContextItemAsDefault
-
Methods inherited from class net.sf.saxon.expr.FunctionCall
addExternalFunctionCallToPathMap, checkArgumentCount, equals, explain, getArguments, getDisplayName, getFunctionName, getNumberOfArguments, hashCode, iterateSubExpressions, preEvaluate, promote, replaceSubExpression, setArguments, setFunctionName, simplify, simplifyArguments, toString, typeCheck
-
Methods inherited from class net.sf.saxon.expr.Expression
addToPathMap, adoptChildExpression, checkForUpdatingSubexpressions, checkPermittedContents, computeDependencies, computeStaticProperties, display, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, evaluatePendingUpdates, explain, findParentOf, getCardinality, getColumnNumber, getColumnNumber, getConstructType, getContainer, getDependencies, getExecutable, getHostLanguage, getImplementationMethod, getIntrinsicDependencies, getLineNumber, getLineNumber, getLocationId, getLocationProvider, getObjectName, getProperties, getProperty, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, getSystemId, hasLoopingSubexpression, implementsStaticTypeCheck, isUpdatingExpression, iterate, iterateEvents, markTailFunctionCalls, process, resetLocalStaticProperties, setContainer, setFiltered, setFlattened, setLocationId, staticTypeCheck, suppressValidation, typeError
-
-
-
-
Method Detail
-
evaluateItem
public Item evaluateItem(XPathContext context) throws XPathException
Evaluate the function- Specified by:
evaluateItem
in interfaceEvaluableItem
- Overrides:
evaluateItem
in classExpression
- Parameters:
context
- The context in which the expression is to be evaluated- Returns:
- the node or atomic value that results from evaluating the expression; or null to indicate that the result is an empty sequence
- Throws:
XPathException
- if any dynamic error occurs evaluating the expression
-
substring
public static java.lang.CharSequence substring(StringValue sv, NumericValue start)
Implement the substring function with two arguments.- Parameters:
sv
- the string valuestart
- the numeric offset (1-based) of the first character to be included in the result (if not an integer, the XPath rules apply)- Returns:
- the substring starting at this position.
-
substring
public static java.lang.CharSequence substring(StringValue sv, NumericValue start, NumericValue len, XPathContext context)
Implement the substring function with three arguments.- Parameters:
sv
- the string valuestart
- the numeric offset (1-based) of the first character to be included in the result (if not an integer, the XPath rules apply)len
- the length of the required substring (again, XPath rules apply)context
- the XPath dynamic context. Provided because some arithmetic computations require it- Returns:
- the substring starting at this position.
-
-