org.exist.xquery.functions.text
Class MatchRegexp

java.lang.Object
  org.exist.xquery.AbstractExpression
      org.exist.xquery.PathExpr
          org.exist.xquery.Function
              org.exist.xquery.functions.text.MatchRegexp

All Implemented Interfaces:

CompiledXQuery, Expression, Optimizable, RewritableExpression, org.xmldb.api.base.CompiledExpression

public class MatchRegexp
extends Function
implements Optimizable

Field Summary

protected int	axis
protected CachedResult	cached
protected QName	contextQName
protected static FunctionParameterSequenceType	FLAGS_PARAM
static java.lang.String	MATCH_ALL_FLAG
protected boolean	optimizeChild
protected boolean	optimizeSelf
protected NodeSet	preselectResult
protected static FunctionParameterSequenceType	REGEX_PARAM
protected static FunctionReturnSequenceType	RETURN_TYPE
static FunctionSignature[]	signatures
protected static FunctionParameterSequenceType	SOURCE_PARAM
protected int	type

Fields inherited from class org.exist.xquery.Function

BUILTIN_FUNCTION_NS, mySignature

Fields inherited from class org.exist.xquery.PathExpr

inPredicate, keepVirtual, LOG, staticContext, steps

Fields inherited from class org.exist.xquery.AbstractExpression

column, context, contextDocSet, contextId, line, unordered

Fields inherited from interface org.exist.xquery.Expression

DOT_TEST, EXPRESSION_ID_INVALID, IGNORE_CONTEXT, IN_NODE_CONSTRUCTOR, IN_PREDICATE, IN_UPDATE, IN_WHERE_CLAUSE, NEED_INDEX_INFO, NO_CONTEXT_ID, NON_STREAMABLE, POSITIONAL_PREDICATE, SINGLE_STEP_EXECUTION, UNORDERED, USE_TREE_TRAVERSAL

Constructor Summary

MatchRegexp(XQueryContext context, FunctionSignature signature)

Method Summary

void	analyze(AnalyzeContextInfo contextInfo) Statically analyze the expression and its subexpressions.
boolean	canOptimize(Sequence contextSequence)
Sequence	eval(Sequence contextSequence, Item contextItem) Evaluate the expression represented by this object.
Sequence	evalQuery(NodeSet nodes, java.util.List<java.lang.String> terms, boolean matchAll)
int	getDependencies() Returns Dependency.DEFAULT_DEPENDENCIES.
protected NodeSet[]	getMatches(DocumentSet docs, NodeSet contextSet, int axis, QName qname, java.util.List<java.lang.String> terms, boolean matchAll)
int	getOptimizeAxis()
protected java.util.List<java.lang.String>	getSearchTerms(Expression termsExpr, Sequence contextSequence)
protected int	getTermDependencies()
boolean	optimizeOnChild()
boolean	optimizeOnSelf()
NodeSet	preSelect(Sequence contextSequence, boolean useContext)
void	resetState(boolean postOptimization) Called to inform an expression that it should reset to its initial state.
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

accept, checkArgument, checkArguments, createFunction, dump, getArgument, getArgumentCount, getArguments, getCardinality, getName, getParent, getParentModule, getSignature, isCalledAs, returnsType, setArguments, setParent, setPrimaryAxis, simplify, toString

Methods inherited from class org.exist.xquery.PathExpr

add, add, addPath, addPredicate, allowMixNodesInReturn, dump, getColumn, getContext, getDocumentSet, getExpression, getLastExpression, getLength, getLine, getLiteralValue, getPrimaryAxis, getSubExpression, getSubExpressionCount, isValid, replaceExpression, replaceLastExpression, reset, setContext, setUseStaticContext

Methods inherited from class org.exist.xquery.AbstractExpression

eval, getContextDocSet, getContextId, getExpressionId, getSource, match, needsReset, setASTNode, setContextDocSet, setContextId, setLocation

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.exist.xquery.Expression

accept, allowMixNodesInReturn, dump, eval, getCardinality, getColumn, getContext, getContextDocSet, getContextId, getExpressionId, getLine, getParent, getPrimaryAxis, getSource, getSubExpression, getSubExpressionCount, match, needsReset, returnsType, setASTNode, setContextDocSet, setContextId, setLocation, setPrimaryAxis, simplify

Methods inherited from interface org.exist.xquery.CompiledXQuery

eval, getSource

Field Detail

SOURCE_PARAM

protected static final FunctionParameterSequenceType SOURCE_PARAM

REGEX_PARAM

protected static final FunctionParameterSequenceType REGEX_PARAM

FLAGS_PARAM

protected static final FunctionParameterSequenceType FLAGS_PARAM

RETURN_TYPE

protected static final FunctionReturnSequenceType RETURN_TYPE

signatures

public static final FunctionSignature[] signatures

MATCH_ALL_FLAG

public static final java.lang.String MATCH_ALL_FLAG

See Also:

Constant Field Values

type

protected int type

cached

protected CachedResult cached

contextQName

protected QName contextQName

axis

protected int axis

optimizeSelf

protected boolean optimizeSelf

optimizeChild

protected boolean optimizeChild

preselectResult

protected NodeSet preselectResult

Constructor Detail

MatchRegexp

public MatchRegexp(XQueryContext context,
                   FunctionSignature signature)

Method Detail

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

canOptimize

public boolean canOptimize(Sequence contextSequence)

Specified by:

canOptimize in interface Optimizable

optimizeOnSelf

public boolean optimizeOnSelf()

Specified by:

optimizeOnSelf in interface Optimizable

optimizeOnChild

public boolean optimizeOnChild()

Specified by:

optimizeOnChild in interface Optimizable

getOptimizeAxis

public int getOptimizeAxis()

Specified by:

getOptimizeAxis in interface Optimizable

preSelect

public NodeSet preSelect(Sequence contextSequence,
                         boolean useContext)
                  throws XPathException

Specified by:

preSelect in interface Optimizable

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

Parameters:

contextSequence - the current context sequence.

contextItem - a single item, taken from context. This defines the item, the expression should work on.

Throws:

XPathException

getSearchTerms

protected java.util.List<java.lang.String> getSearchTerms(Expression termsExpr,
                                                          Sequence contextSequence)
                                                   throws XPathException

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

Returns:

set of bit-flags

See Also:

Expression.getDependencies()

evalQuery

public Sequence evalQuery(NodeSet nodes,
                          java.util.List<java.lang.String> terms,
                          boolean matchAll)
                   throws XPathException

Throws:

XPathException

getMatches

protected NodeSet[] getMatches(DocumentSet docs,
                               NodeSet contextSet,
                               int axis,
                               QName qname,
                               java.util.List<java.lang.String> terms,
                               boolean matchAll)
                        throws XPathException

Throws:

XPathException

getTermDependencies

protected int getTermDependencies()
                           throws XPathException

Throws:

XPathException

resetState

public void resetState(boolean postOptimization)

Description copied from interface: Expression

Called to inform an expression that it should reset to its initial state. All cached data in the expression object should be dropped. For example, the xmldb:document() function calls this method whenever the input document set has changed.

Specified by:

resetState in interface Expression

Overrides:

resetState in class PathExpr

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 - Xpath2 expression

Returns:

Java regexp representation of pattern

Throws:

XPathException