org.exist.xquery.functions
Class FunMatches

java.lang.Object
  org.exist.xquery.AbstractExpression
      org.exist.xquery.PathExpr
          org.exist.xquery.Function
              org.exist.xquery.functions.FunMatches

All Implemented Interfaces:

CompiledXQuery, Expression

Direct Known Subclasses:

FunReplace, FunTokenize

public class FunMatches

extends Function

Implements the fn:matches() function. Based on the java.util.regex package for regular expression support.

Author:

Wolfgang Meier (wolfgang@exist-db.org)

Field Summary

protected java.util.regex.Matcher	matcher
protected java.util.regex.Pattern	pat
static FunctionSignature[]	signatures

Fields inherited from class org.exist.xquery.Function

BUILTIN_FUNCTION_NS, mySignature

Fields inherited from class org.exist.xquery.PathExpr

inPredicate, keepVirtual, LOG, source, steps

Fields inherited from class org.exist.xquery.AbstractExpression

context, contextDocSet, contextId

Fields inherited from interface org.exist.xquery.Expression

EXPRESSION_ID_INVALID, IGNORE_CONTEXT, IN_PREDICATE, IN_UPDATE, IN_WHERE_CLAUSE, NO_CONTEXT_ID, SINGLE_STEP_EXECUTION

Constructor Summary

FunMatches(XQueryContext context, FunctionSignature signature)

Method Summary

void	analyze(AnalyzeContextInfo contextInfo) Statically analyze the expression and its subexpressions.
Sequence	eval(Sequence contextSequence, Item contextItem) Evaluate the expression represented by this object.
int	getDependencies() Returns Dependency.DEFAULT_DEPENDENCIES.
protected static int	parseFlags(java.lang.String s)
int	returnsType() The static return type of the expression.
void	setArguments(java.util.List arguments) Set the (static) arguments for this function from a list of expressions.
protected java.lang.String	translateRegexp(java.lang.String pattern) Translates the regular expression from XPath2 syntax to java regex syntax.

Methods inherited from class org.exist.xquery.Function

checkArgument, checkArguments, createFunction, dump, getArgument, getArgumentCount, getArguments, getASTNode, getCardinality, getName, getParent, getSignature, isCalledAs, setASTNode, setParent, setPrimaryAxis, toString

Methods inherited from class org.exist.xquery.PathExpr

add, add, addPath, addPredicate, dump, getContext, getDocumentSet, getExpression, getLastExpression, getLength, getLiteralValue, getSource, isValid, replaceLastExpression, reset, resetState, setContext, setSource

Methods inherited from class org.exist.xquery.AbstractExpression

eval, getContextDocSet, getContextId, getExpressionId, setContextDocSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.exist.xquery.CompiledXQuery

eval

Field Detail

signatures

public static final FunctionSignature[] signatures

matcher

protected java.util.regex.Matcher matcher

pat

protected java.util.regex.Pattern pat

Constructor Detail

FunMatches

public FunMatches(XQueryContext context,
                  FunctionSignature signature)

Parameters:

context -

Method Detail

setArguments

public void setArguments(java.util.List arguments)
                  throws XPathException

Description copied from class: Function

Set the (static) arguments for this function from a list of expressions. This will also check the type and cardinality of the passed argument expressions.

Overrides:

setArguments in class Function

Parameters:

arguments -

Throws:

XPathException

getDependencies

public int getDependencies()

Description copied from class: AbstractExpression

Returns Dependency.DEFAULT_DEPENDENCIES.

Specified by:

getDependencies in interface Expression

Overrides:

getDependencies in class Function

returnsType

public int returnsType()

Description copied from interface: Expression

The static return type of the expression. This method should return one of the type constants defined in class Type. If the return type cannot be determined statically, return Type.ITEM.

Specified by:

returnsType in interface Expression

Overrides:

returnsType in class Function

analyze

public void analyze(AnalyzeContextInfo contextInfo)
             throws XPathException

Description copied from interface: Expression

Statically analyze the expression and its subexpressions. During the static analysis phase, the query engine can detect unknown variables and some type errors.

Specified by:

analyze in interface Expression

Overrides:

analyze in class Function

Throws:

XPathException

eval

public Sequence eval(Sequence contextSequence,
                     Item contextItem)
              throws XPathException

Description copied from interface: Expression

Evaluate the expression represented by this object. Depending on the context in which this expression is executed, either the context sequence, the context item or both of them may be set. An implementing class should know how to handle this. The general contract is as follows: if the Dependency.CONTEXT_ITEM bit is set in the bit field returned by Expression.getDependencies(), the eval method will be called once for every item in the context sequence. The contextItem parameter will be set to the current item. Otherwise, the eval method will only be called once for the whole context sequence and contextItem will be null. eXist tries to process the entire context set in one, single step whenever possible. Thus, most classes only expect context to contain a list of nodes which represents the current context of the expression. The position() function in XPath is an example for an expression, which requires both, context sequence and context item to be set. The context sequence might be a node set, a sequence of atomic values or a single node or atomic value.

Specified by:

eval in interface Expression

Specified by:

eval in class Function

Throws:

XPathException

translateRegexp

protected java.lang.String translateRegexp(java.lang.String pattern)
                                    throws XPathException

Translates the regular expression from XPath2 syntax to java regex syntax.

Parameters:

pattern -

Returns:

Throws:

XPathException

parseFlags

protected static final int parseFlags(java.lang.String s)
                               throws XPathException

Throws:

XPathException