net.sf.saxon.functions

Class SubstringBefore

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.CollatingFunctionFixed

net.sf.saxon.functions.SubstringBefore

All Implemented Interfaces:

java.lang.Iterable<Function>, Callable, StatefulSystemFunction, Function, GroundedValue<Function>, Item<Function>, Sequence<Function>

public class SubstringBefore
extends CollatingFunctionFixed

Implements the fn:substring-before() function with the collation already known

Constructor Summary

Constructors

Constructor and Description
SubstringBefore()

Method Summary

Modifier and Type	Method and Description
StringValue	call(XPathContext context, Sequence[] arguments) Evaluate the expression
java.lang.String	getCompilerName() Get the (local) name of a class that can be used to generate bytecode for this system function
boolean	isSubstringMatchingFunction() Ask whether this function needs a collation that can handle substring matching

Methods inherited from class net.sf.saxon.functions.CollatingFunctionFixed

copy, exportAttributes, getAtomicComparer, getPreAllocatedAtomicComparer, getStringCollator, importAttributes, preAllocateComparer, setCollationName, setRetainedStaticContext

Methods inherited from class net.sf.saxon.functions.SystemFunction

dependsOnContextItem, dynamicCall, equals, export, exportAdditionalArguments, fixArguments, getArity, getCardinality, getContextNode, getDescription, getDetails, getErrorCodeForTypeErrors, getFunctionItemType, getFunctionName, getIntegerBounds, getNetCost, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getSpecialProperties, getStaticBaseUriString, getStreamerName, isTrustedResultType, makeCall, makeFunction, makeFunctionCall, makeOptimizedFunctionCall, resultIfEmpty, setArity, setDetails, supplyTypeInformation, toShortString, toString, typeCheckCaller

Methods inherited from class net.sf.saxon.functions.AbstractFunction

atomize, deepEquals, effectiveBooleanValue, getAnnotations, getStringValue, getStringValueCS, isArray, isMap, makeNewContext, simplify, typeCheck

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.saxon.om.Function

argumentArray, getGenre

Methods inherited from interface net.sf.saxon.om.Item

getLength, head, isStreamed, itemAt, iterate, iterator, reduce, subsequence, toGroundedValue

Methods inherited from interface net.sf.saxon.om.GroundedValue

asIterable, materialize

Methods inherited from interface net.sf.saxon.om.Sequence

makeRepeatable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SubstringBefore

public SubstringBefore()

Method Detail

isSubstringMatchingFunction

public boolean isSubstringMatchingFunction()

Description copied from class: CollatingFunctionFixed

Ask whether this function needs a collation that can handle substring matching

Overrides:

isSubstringMatchingFunction in class CollatingFunctionFixed

Returns:

true in the case of functions such as contains() and starts-with() where substring matching is required. Returns false by default;

call

public StringValue call(XPathContext context,
                        Sequence[] arguments)
                 throws XPathException

Evaluate the expression

Parameters:

context - the dynamic evaluation context

arguments - the values of the arguments, supplied as Sequences

Returns:

the result of the evaluation, in the form of a Sequence

Throws:

XPathException - if a dynamic error occurs during the evaluation of the expression

getCompilerName

public java.lang.String getCompilerName()

Description copied from class: SystemFunction

Get the (local) name of a class that can be used to generate bytecode for this system function

Overrides:

getCompilerName in class SystemFunction

Returns:

the name of a bytecode generation class, or null if there is no bytecode support for this function