Package net.sf.saxon.functions

Class Matches

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.RegexFunction

net.sf.saxon.functions.Matches

All Implemented Interfaces:

Callable, StatefulSystemFunction, FunctionItem, GroundedValue, Item, Sequence

public class Matches
extends RegexFunction

This class implements the 3-argument matches() function for regular expression matching

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Matches.MatchesFnElaborator

Constructor Summary

Constructors

Constructor	Description
Matches()

Method Summary

Modifier and Type	Method	Description
protected boolean	allowRegexMatchingEmptyString()
BooleanValue	call(XPathContext context, Sequence[] arguments)	Evaluate the expression
boolean	evalMatches(UnicodeString input, UnicodeString regex, UnicodeString flags, XPathContext context)
boolean	evalMatches(AtomicValue input, AtomicValue regex, UnicodeString flags, XPathContext context)	Interface used by compiled bytecode
String	getCompilerName()	Get the (local) name of a class that can be used to generate bytecode for this system function
Elaborator	getElaborator()	Make an elaborator for a system function call on this function

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

copy, getRegularExpression, getStaticRegex, makeFunctionCall, makeOptimizedFunctionCall

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

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

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

atomize, 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

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

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

makeRepeatable

Constructor Detail

Matches

public Matches()

Method Detail

allowRegexMatchingEmptyString

protected boolean allowRegexMatchingEmptyString()

Specified by:

allowRegexMatchingEmptyString in class RegexFunction

evalMatches

public boolean evalMatches(AtomicValue input,
                           AtomicValue regex,
                           UnicodeString flags,
                           XPathContext context)
                    throws XPathException

Interface used by compiled bytecode

Parameters:

input - the value to be tested

regex - the regular expression

flags - the flags

context - the dynamic context

Returns:

true if the string matches the regex

Throws:

XPathException - if a dynamic error occurs

evalMatches

public boolean evalMatches(UnicodeString input,
                           UnicodeString regex,
                           UnicodeString flags,
                           XPathContext context)
                    throws XPathException

Throws:

XPathException

call

public BooleanValue 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 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

getElaborator

public Elaborator getElaborator()

Make an elaborator for a system function call on this function

Overrides:

getElaborator in class SystemFunction

Returns:

a suitable elaborator; or null if no custom elaborator is available