Package net.sf.saxon.functions

Class Contains

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.CollatingFunctionFixed

net.sf.saxon.functions.Contains

All Implemented Interfaces:

Callable, ArityTwoFunction, IFunctionWithRetainedParameterNames, StatefulSystemFunction, FunctionItem, GroundedValue, Item, Sequence

public class Contains
extends CollatingFunctionFixed
implements ArityTwoFunction

Implements the fn:contains() function, with the collation already known

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Contains.ContainsFnElaborator	Expression elaborator for a call to contains(), starts-with(), or ends-with()

Constructor Summary

Constructors

Constructor	Description
Contains()

Method Summary

Modifier and Type	Method	Description
BooleanValue	call(XPathContext context, Sequence[] arguments)	Call the Callable.
Sequence	call2(XPathContext context, Sequence arg0, Sequence arg1)	Call a function with two arguments
Elaborator	getElaborator()	Make an elaborator for this expression
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, getNetCost, getOperandRoles, getParameterNames, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getSpecialProperties, getStaticBaseUriString, getStreamerName, getUniqueIdentifier, getUniStringArg, hashCode, isSequenceVariadic, isTrustedResultType, makeCall, makeFunction, makeFunction40, makeFunctionCall, makeOptimizedFunctionCall, makeTrueFunctionCall, resultIfEmpty, setArity, setDetails, supplyTypeInformation, toShortString, toString, typeCheckCaller

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

atomize, deepEqual40, deepEquals, effectiveBooleanValue, getAnnotations, getUnicodeStringValue, isArray, isMap, makeNewContext, simplify, typeCheck

Methods inherited from class java.lang.Object

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

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

getGenre

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

asIterable, concatenate, containsNode, materialize

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

getLabel, getLength, getStringValue, head, isStreamed, itemAt, iterate, reduce, subsequence

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

makeRepeatable

Constructor Details

Contains

public Contains()

Method Details

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 BooleanValue call(XPathContext context,
 Sequence[] arguments)
                  throws XPathException

Description copied from interface: Callable

Call the Callable.

Specified by:

call in interface Callable

Parameters:

context - the dynamic evaluation context

arguments - the values of the arguments, supplied as Sequences.

Generally it is advisable, if calling iterate() to process a supplied sequence, to call it only once; if the value is required more than once, it should first be converted to a GroundedValue by calling the utility method SequenceTool.toGroundedValue().

If the expected value is a single item, the item should be obtained by calling Sequence.head(): it cannot be assumed that the item will be passed as an instance of Item or AtomicValue.

It is the caller's responsibility to perform any type conversions required to convert arguments to the type expected by the callee. An exception is where this Callable is explicitly an argument-converting wrapper around the original Callable.

Returns:

the result of the evaluation, in the form of a Sequence. It is the responsibility of the callee to ensure that the type of result conforms to the expected result type.

Throws:

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

call2

public Sequence call2(XPathContext context,
 Sequence arg0,
 Sequence arg1)
               throws XPathException

Call a function with two arguments

Specified by:

call2 in interface ArityTwoFunction

Parameters:

context - the dynamic evaluation context

arg0 - the first argument

arg1 - the second argument

Returns:

the result of the function call

Throws:

XPathException - if the call fails with a dynamic error

getElaborator

public Elaborator getElaborator()

Make an elaborator for this expression

Overrides:

getElaborator in class SystemFunction

Returns:

a suitable elaborator