SimilarImpl (Jackrabbit Oak 1.23-SNAPSHOT API)

java.lang.Object
- org.apache.jackrabbit.oak.query.ast.ConstraintImpl
- - org.apache.jackrabbit.oak.query.ast.SimilarImpl

public class SimilarImpl
extends ConstraintImpl

Support for "similar(...)

Field Summary

Fields
Modifier and Type Field and Description

static String MORE_LIKE_THIS_PREFIX

static String NATIVE_LUCENE_LANGUAGE

protected QueryImpl query

Fields
Modifier and Type	Field and Description
`static String`	`MORE_LIKE_THIS_PREFIX`
`static String`	`NATIVE_LUCENE_LANGUAGE`
`protected QueryImpl`	`query`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`protected String`	`getLocalPath(String path)` Calculate the session local path (the path excluding the workspace name) if possible.
`StaticOperandImpl`	`getPathExpression()`
`Set<PropertyExistenceImpl>`	`getPropertyExistenceConditions()` Get the set of property existence conditions that can be derived for this condition.
`Set<SelectorImpl>`	`getSelectors()` Get the set of selectors for the given condition.
`protected String`	`normalizePath(String path)` Validate and normalize the path.
`protected String`	`normalizePropertyName(String propertyName)` Normalize the property name (including namespace remapping).
`protected String`	`protect(Object expression)`
`protected String`	`quote(String pathOrName)`
`protected String`	`quoteJson(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)`
`String`	`toString()`

Methods inherited from class org.apache.jackrabbit.oak.query.ast.ConstraintImpl
containsUnfilteredFullTextCondition, convertToUnion, equals, evaluateStop, getFullTextConstraint, hashCode, simplify

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NATIVE_LUCENE_LANGUAGE
```
public static final String NATIVE_LUCENE_LANGUAGE
```
    See Also:
    
    Constant Field Values
  - MORE_LIKE_THIS_PREFIX
```
public static final String MORE_LIKE_THIS_PREFIX
```
    See Also:
    
    Constant Field Values
  - query
```
protected QueryImpl query
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - 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
  - getPropertyExistenceConditions
```
public 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)
  - 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
  - getSelectors
```
public 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)
  - bindSelector
```
public void bindSelector(SourceImpl source)
```
  - getPathExpression
```
public StaticOperandImpl getPathExpression()
```
  - 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 String protect(Object expression)
```
  - quote
```
protected String quote(String pathOrName)
```
  - quoteJson
```
protected String quoteJson(String string)
```
  - setQuery
```
public void setQuery(QueryImpl query)
```
  - normalizePropertyName
```
protected String normalizePropertyName(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 String normalizePath(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 String getLocalPath(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

Class SimilarImpl

Field Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

NATIVE_LUCENE_LANGUAGE

MORE_LIKE_THIS_PREFIX

query

Method Detail

toString

evaluate

getPropertyExistenceConditions

restrict

restrictPushDown

getSelectors

bindSelector

getPathExpression

copyOf

requiresFullTextIndex

protect

quote

quoteJson

setQuery

normalizePropertyName

normalizePath

convertValueToType

getLocalPath