net.sf.saxon.functions

Class Contains

java.lang.Object

net.sf.saxon.expr.Expression

net.sf.saxon.expr.FunctionCall

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.CollatingFunction

net.sf.saxon.functions.Contains

All Implemented Interfaces:

java.io.Serializable, javax.xml.transform.SourceLocator, LocationProvider, SaxonLocator, EvaluableItem, SequenceIterable, InstructionInfo, org.xml.sax.Locator

public class Contains
extends CollatingFunction

This class implements the contains(), starts-with(), ends-with(), substring-before(), and substring-after() functions

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	AFTER
static int	BEFORE
static int	CONTAINS
static int	ENDSWITH
static int	STARTSWITH

Fields inherited from class net.sf.saxon.functions.CollatingFunction

stringCollator

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 and Description
Contains()

Method Summary

Methods

Modifier and Type	Method and Description
Item	evaluateItem(XPathContext context) Evaluate the function

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

checkArguments, copy, getAtomicComparer, getCollator, getExpressionBaseURI, getStringCollator

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

addContextDocumentArgument, addDocToPathMap, computeCardinality, computeSpecialProperties, 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

Methods inherited from class java.lang.Object

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

Field Detail

CONTAINS

public static final int CONTAINS

See Also:

Constant Field Values

STARTSWITH

public static final int STARTSWITH

See Also:

Constant Field Values

ENDSWITH

public static final int ENDSWITH

See Also:

Constant Field Values

AFTER

public static final int AFTER

See Also:

Constant Field Values

BEFORE

public static final int BEFORE

See Also:

Constant Field Values

Constructor Detail

Contains

public Contains()

Method Detail

evaluateItem

public Item evaluateItem(XPathContext context)
                  throws XPathException

Evaluate the function

Specified by:

evaluateItem in interface EvaluableItem

Overrides:

evaluateItem in class Expression

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