org.apache.jackrabbit.oak.query.ast

Class FullTextSearchImpl

java.lang.Object

org.apache.jackrabbit.oak.query.ast.ConstraintImpl

org.apache.jackrabbit.oak.query.ast.FullTextSearchImpl

Direct Known Subclasses:

NotFullTextSearchImpl

public class FullTextSearchImpl
extends ConstraintImpl

A fulltext "contains(...)" condition.

Field Summary

Fields

Modifier and Type	Field and Description
protected QueryImpl	query

Constructor Summary

Constructors

Constructor and Description
FullTextSearchImpl(java.lang.String selectorName, java.lang.String propertyName, StaticOperandImpl fullTextSearchExpression)

Method Summary

Modifier and Type	Method and Description
void	bindSelector(SourceImpl source)
protected PropertyValue	convertValueToType(PropertyValue v, PropertyValue targetType)
org.apache.jackrabbit.oak.query.ast.AstElement	copyOf()
boolean	evaluate() Evaluate the result using the currently set values.
boolean	evaluateStop() Whether this condition will, from now on, always evaluate to false.
FullTextExpression	getFullTextConstraint(SelectorImpl s) Get the (combined) full-text constraint.
StaticOperandImpl	getFullTextSearchExpression()
protected java.lang.String	getLocalPath(java.lang.String path) Calculate the session local path (the path excluding the workspace name) if possible.
java.util.Set<PropertyExistenceImpl>	getPropertyExistenceConditions() Get the set of property existence conditions that can be derived for this condition.
java.util.Set<SelectorImpl>	getSelectors() Get the set of selectors for the given condition.
protected java.lang.String	normalizePath(java.lang.String path) Validate and normalize the path.
protected java.lang.String	normalizePropertyName(java.lang.String propertyName) Normalize the property name (including namespace remapping).
protected java.lang.String	protect(java.lang.Object expression)
protected java.lang.String	quote(java.lang.String pathOrName)
protected java.lang.String	quoteJson(java.lang.String string)
boolean	requiresFullTextIndex() Whether the constraint contains a fulltext condition that requires using a fulltext index, because the condition can only be evaluated there.
void	restrict(FilterImpl f) Apply the condition to the filter, further restricting the filter if possible.
void	restrictPushDown(SelectorImpl s) Push as much of the condition down to this selector, further restricting the selector condition if possible.
void	setQuery(QueryImpl query)
java.lang.String	toString()

Methods inherited from class org.apache.jackrabbit.oak.query.ast.ConstraintImpl

containsUnfilteredFullTextCondition, convertToUnion, equals, hashCode, simplify

Methods inherited from class java.lang.Object

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

Field Detail

query

protected QueryImpl query

Constructor Detail

FullTextSearchImpl

public FullTextSearchImpl(java.lang.String selectorName,
                          java.lang.String propertyName,
                          StaticOperandImpl fullTextSearchExpression)

Method Detail

getFullTextSearchExpression

public StaticOperandImpl getFullTextSearchExpression()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPropertyExistenceConditions

public java.util.Set<PropertyExistenceImpl> getPropertyExistenceConditions()

Description copied from class: ConstraintImpl

Get the set of property existence conditions that can be derived for this condition. For example, for the condition "x=1 or x=2", the property existence condition is "x is not null". For the condition "x=1 or y=2", there is no such condition. For the condition "x=1 and y=1", there are two (x is not null, and y is not null).

Specified by:

getPropertyExistenceConditions in class ConstraintImpl

Returns:

the common property existence condition (possibly empty)

getFullTextConstraint

public FullTextExpression getFullTextConstraint(SelectorImpl s)

Description copied from class: ConstraintImpl

Get the (combined) full-text constraint. For constraints of the form "contains(*, 'x') or contains(*, 'y')", the combined expression is returned. If there is none, null is returned. For constraints of the form "contains(*, 'x') or z=1", null is returned as the full-text index cannot be used in this case for filtering (as it might filter out the z=1 nodes).

Overrides:

getFullTextConstraint in class ConstraintImpl

Parameters:

s - the selector

Returns:

the full-text constraint, if there is any, or null if not

getSelectors

public java.util.Set<SelectorImpl> getSelectors()

Description copied from class: ConstraintImpl

Get the set of selectors for the given condition.

Specified by:

getSelectors in class ConstraintImpl

Returns:

the set of selectors (possibly empty)

evaluate

public boolean evaluate()

Description copied from class: ConstraintImpl

Evaluate the result using the currently set values.

Specified by:

evaluate in class ConstraintImpl

Returns:

true if the constraint matches

evaluateStop

public boolean evaluateStop()

Description copied from class: ConstraintImpl

Whether this condition will, from now on, always evaluate to false. This is the case for example for full-text constraints if there is no full-text index (unless FullTextComparisonWithoutIndex is enabled). This will also allow is to add conditions that stop further processing for other reasons, similar to "WHERE ROWNUM < 10" in Oracle.

Overrides:

evaluateStop in class ConstraintImpl

Returns:

true if further processing should be stopped

bindSelector

public void bindSelector(SourceImpl source)

restrict

public void restrict(FilterImpl f)

Description copied from class: ConstraintImpl

Apply the condition to the filter, further restricting the filter if possible. This may also verify the data types are compatible, and that paths are valid.

Specified by:

restrict in class ConstraintImpl

Parameters:

f - the filter

restrictPushDown

public void restrictPushDown(SelectorImpl s)

Description copied from class: ConstraintImpl

Push as much of the condition down to this selector, further restricting the selector condition if possible. This is important for a join: for example, the query "select * from a inner join b on a.x=b.x where a.y=1 and b.y=1", the condition "a.y=1" can be pushed down to "a", and the condition "b.y=1" can be pushed down to "b". That means it is possible to use an index in this case.

Specified by:

restrictPushDown in class ConstraintImpl

Parameters:

s - the selector

copyOf

public org.apache.jackrabbit.oak.query.ast.AstElement copyOf()

Returns:

a clone of self. Default implementation in AstElement returns same reference to this.

requiresFullTextIndex

public boolean requiresFullTextIndex()

Description copied from class: ConstraintImpl

Whether the constraint contains a fulltext condition that requires using a fulltext index, because the condition can only be evaluated there.

Overrides:

requiresFullTextIndex in class ConstraintImpl

Returns:

true if yes

protect

protected java.lang.String protect(java.lang.Object expression)

quote

protected java.lang.String quote(java.lang.String pathOrName)

quoteJson

protected java.lang.String quoteJson(java.lang.String string)

setQuery

public void setQuery(QueryImpl query)

normalizePropertyName

protected java.lang.String normalizePropertyName(java.lang.String propertyName)

Normalize the property name (including namespace remapping). Asterisks are kept.

Parameters:

propertyName - the property name to normalize

Returns:

the normalized (oak-) property name

normalizePath

protected java.lang.String normalizePath(java.lang.String path)

Validate and normalize the path.

Parameters:

path - the path to validate

Returns:

the validated and normalized path

convertValueToType

protected PropertyValue convertValueToType(PropertyValue v,
                                           PropertyValue targetType)

getLocalPath

protected java.lang.String getLocalPath(java.lang.String path)

Calculate the session local path (the path excluding the workspace name) if possible.

Parameters:

path - the absolute path

Returns:

the session local path, or null if not within this workspace