SelectorImpl (Jackrabbit Oak 1.10-SNAPSHOT API)

java.lang.Object
- org.apache.jackrabbit.oak.query.ast.SourceImpl
- - org.apache.jackrabbit.oak.query.ast.SelectorImpl

public class SelectorImpl
extends SourceImpl

A selector within a query.

Field Summary

Fields
Modifier and Type Field and Description

protected QueryImpl query

Fields
Modifier and Type	Field and Description
`protected QueryImpl`	`query`

Constructor Summary

Constructors
Constructor and Description

SelectorImpl(NodeTypeInfo nodeTypeInfo, String selectorName)

Constructors
Constructor and Description
`SelectorImpl(NodeTypeInfo nodeTypeInfo, String selectorName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addJoinCondition(JoinConditionImpl joinCondition, boolean forThisSelector)` Add the join condition (the ON ...
`protected PropertyValue`	`convertValueToType(PropertyValue v, PropertyValue targetType)`
`SourceImpl`	`copyOf()`
`FilterImpl`	`createFilter(boolean preparing)` Create the filter condition for planning or execution.
`PropertyValue`	`currentOakProperty(String oakPropertyName)` Get the property value.
`String`	`currentPath()` Get the current absolute Oak path (normalized).
`PropertyValue`	`currentProperty(String propertyName)` The value for the given selector for the current node.
`PropertyValue`	`currentProperty(String propertyName, int propertyType)` The value for the given selector for the current node, filtered by property type.
`Tree`	`currentTree()` Get the tree at the current path.
`boolean`	`equals(Object other)`
`void`	`execute(NodeState rootState)` Execute the query.
`SelectorExecutionPlan`	`getExecutionPlan()`
`String`	`getIndexCostInfo(NodeState rootState)` Get the index cost as a JSON string.
`ArrayList<SourceImpl>`	`getInnerJoinSelectors()` Get all sources that are joined via inner join.
`protected String`	`getLocalPath(String path)` Calculate the session local path (the path excluding the workspace name) if possible.
`Set<String>`	`getMixinTypes()`
`String`	`getNodeType()`
`String`	`getPlan(NodeState rootState)` Get the query plan.
`Set<String>`	`getPrimaryTypes()`
`QueryImpl`	`getQuery()`
`long`	`getScanCount()`
`SelectorImpl`	`getSelector(String selectorName)` Get the selector with the given name, or null if not found.
`List<ConstraintImpl>`	`getSelectorConstraints()`
`String`	`getSelectorName()`
`long`	`getSize(NodeState rootState, Result.SizePrecision precision, long max)` Get the size if known.
`Set<String>`	`getSupertypes()`
`Iterable<String>`	`getWildcardColumns()`
`int`	`hashCode()`
`boolean`	`isOuterJoinRightHandSide()` Whether any selector is the outer-join right hand side.
`boolean`	`isPrepared()`
`boolean`	`isVirtualRow()`
`boolean`	`matchesAllTypes()`
`boolean`	`next()` Go to the next node for the given source.
`protected String`	`normalizePath(String path)` Validate and normalize the path.
`protected String`	`normalizePropertyName(String propertyName)` Normalize the property name (including namespace remapping).
`ExecutionPlan`	`prepare()` Prepare executing the query (recursively).
`void`	`prepare(ExecutionPlan p)` Re-apply a previously prepared plan.
`protected String`	`protect(Object expression)`
`protected String`	`quote(String pathOrName)`
`protected String`	`quoteJson(String string)`
`void`	`restrictSelector(ConstraintImpl constraint)`
`void`	`setOuterJoin(boolean outerJoinLeftHandSide, boolean outerJoinRightHandSide)` Set whether this source is the left hand side or right hand side of a left outer join.
`void`	`setQuery(QueryImpl query)`
`void`	`setQueryConstraint(ConstraintImpl queryConstraint)` Set the complete constraint of the query (the WHERE ...
`String`	`toString()`
`void`	`unprepare()` Undo a prepare.

Methods inherited from class org.apache.jackrabbit.oak.query.ast.SourceImpl
getExistingSelector, getInnerJoinConditions

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

- Field Detail
  - query
```
protected QueryImpl query
```
- Constructor Detail
  - SelectorImpl
```
public SelectorImpl(NodeTypeInfo nodeTypeInfo,
                    String selectorName)
```
- Method Detail
  - getSelectorName
```
public String getSelectorName()
```
  - getNodeType
```
public String getNodeType()
```
  - matchesAllTypes
```
public boolean matchesAllTypes()
```
  - getSupertypes
```
@Nonnull
public Set<String> getSupertypes()
```
    Returns:
    
    all of the matching supertypes, or empty if the matchesAllTypes flag is set
  - getPrimaryTypes
```
@Nonnull
public Set<String> getPrimaryTypes()
```
    Returns:
    
    all of the matching primary subtypes, or empty if the matchesAllTypes flag is set
  - getMixinTypes
```
@Nonnull
public Set<String> getMixinTypes()
```
    Returns:
    
    all of the matching mixin types, or empty if the matchesAllTypes flag is set
  - getWildcardColumns
```
public Iterable<String> getWildcardColumns()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isPrepared
```
public boolean isPrepared()
```
  - unprepare
```
public void unprepare()
```
    Description copied from class: SourceImpl
    
    Undo a prepare.
    
    Specified by:
    
    unprepare in class SourceImpl
  - prepare
```
public void prepare(ExecutionPlan p)
```
    Description copied from class: SourceImpl
    
    Re-apply a previously prepared plan. This will also 're-wire' the selectors with the join constraints
    
    Specified by:
    
    prepare in class SourceImpl
    
    Parameters:
    
    p - the plan to use
  - prepare
```
public ExecutionPlan prepare()
```
    Description copied from class: SourceImpl
    
    Prepare executing the query (recursively). This will 'wire' the selectors with the join constraints, and decide which index to use.
    
    Specified by:
    
    prepare in class SourceImpl
    
    Returns:
    
    the execution plan
  - getExecutionPlan
```
public SelectorExecutionPlan getExecutionPlan()
```
  - setQueryConstraint
```
public void setQueryConstraint(ConstraintImpl queryConstraint)
```
    Description copied from class: SourceImpl
    
    Set the complete constraint of the query (the WHERE ... condition).
    
    Specified by:
    
    setQueryConstraint in class SourceImpl
    
    Parameters:
    
    queryConstraint - the constraint
  - setOuterJoin
```
public void setOuterJoin(boolean outerJoinLeftHandSide,
                         boolean outerJoinRightHandSide)
```
    Description copied from class: SourceImpl
    
    Set whether this source is the left hand side or right hand side of a left outer join.
    
    Specified by:
    
    setOuterJoin in class SourceImpl
    
    Parameters:
    
    outerJoinLeftHandSide - true if yes
    
    outerJoinRightHandSide - true if yes
  - addJoinCondition
```
public void addJoinCondition(JoinConditionImpl joinCondition,
                             boolean forThisSelector)
```
    Description copied from class: SourceImpl
    
    Add the join condition (the ON ... condition).
    
    Specified by:
    
    addJoinCondition in class SourceImpl
    
    Parameters:
    
    joinCondition - the join condition
    
    forThisSelector - if set, the join condition can only be evaluated when all previous selectors are executed.
  - execute
```
public void execute(NodeState rootState)
```
    Description copied from class: SourceImpl
    
    Execute the query. The current node is set to before the first row.
    
    Specified by:
    
    execute in class SourceImpl
    
    Parameters:
    
    rootState - root state of the given revision
  - getPlan
```
public String getPlan(NodeState rootState)
```
    Description copied from class: SourceImpl
    
    Get the query plan.
    
    Specified by:
    
    getPlan in class SourceImpl
    
    Parameters:
    
    rootState - the root
    
    Returns:
    
    the query plan
  - getIndexCostInfo
```
public String getIndexCostInfo(NodeState rootState)
```
    Description copied from class: SourceImpl
    
    Get the index cost as a JSON string.
    
    Specified by:
    
    getIndexCostInfo in class SourceImpl
    
    Parameters:
    
    rootState - the root
    
    Returns:
    
    the cost
  - createFilter
```
public FilterImpl createFilter(boolean preparing)
```
    Create the filter condition for planning or execution.
    
    Specified by:
    
    createFilter in class SourceImpl
    
    Parameters:
    
    preparing - whether a filter for the prepare phase should be made
    
    Returns:
    
    the filter
  - next
```
public boolean next()
```
    Description copied from class: SourceImpl
    
    Go to the next node for the given source. This will also filter the result for the right node type if required.
    
    Specified by:
    
    next in class SourceImpl
    
    Returns:
    
    true if there is a next row
  - currentPath
```
public String currentPath()
```
    Get the current absolute Oak path (normalized).
    
    Returns:
    
    the path
  - currentTree
```
public Tree currentTree()
```
    Get the tree at the current path.
    
    Returns:
    
    the current tree, or null
  - currentProperty
```
public PropertyValue currentProperty(String propertyName)
```
    The value for the given selector for the current node.
    
    Parameters:
    
    propertyName - the JCR (not normalized) property name
    
    Returns:
    
    the property value
  - currentProperty
```
public PropertyValue currentProperty(String propertyName,
                                     int propertyType)
```
    The value for the given selector for the current node, filtered by property type.
    
    Parameters:
    
    propertyName - the JCR (not normalized) property name
    
    propertyType - only include properties of this type
    
    Returns:
    
    the property value (possibly null)
  - currentOakProperty
```
public PropertyValue currentOakProperty(String oakPropertyName)
```
    Get the property value. The property name may be relative. The special property names "jcr:path", "jcr:score" and "rep:excerpt" are supported.
    
    Parameters:
    
    oakPropertyName - (must already be normalized)
    
    Returns:
    
    the property value or null if not found
  - isVirtualRow
```
public boolean isVirtualRow()
```
  - getSelector
```
public SelectorImpl getSelector(String selectorName)
```
    Description copied from class: SourceImpl
    
    Get the selector with the given name, or null if not found.
    
    Specified by:
    
    getSelector in class SourceImpl
    
    Parameters:
    
    selectorName - the selector name
    
    Returns:
    
    the selector, or null
  - getScanCount
```
public long getScanCount()
```
  - restrictSelector
```
public void restrictSelector(ConstraintImpl constraint)
```
  - getSelectorConstraints
```
public List<ConstraintImpl> getSelectorConstraints()
```
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getInnerJoinSelectors
```
public ArrayList<SourceImpl> getInnerJoinSelectors()
```
    Description copied from class: SourceImpl
    
    Get all sources that are joined via inner join. (These can be swapped.)
    
    Specified by:
    
    getInnerJoinSelectors in class SourceImpl
    
    Returns:
    
    the list of selectors (sorted from left to right)
  - isOuterJoinRightHandSide
```
public boolean isOuterJoinRightHandSide()
```
    Description copied from class: SourceImpl
    
    Whether any selector is the outer-join right hand side.
    
    Specified by:
    
    isOuterJoinRightHandSide in class SourceImpl
    
    Returns:
    
    true if there is any
  - getQuery
```
public QueryImpl getQuery()
```
  - getSize
```
public long getSize(NodeState rootState,
                    Result.SizePrecision precision,
                    long max)
```
    Description copied from class: SourceImpl
    
    Get the size if known.
    
    Specified by:
    
    getSize in class SourceImpl
    
    Parameters:
    
    rootState - the root node state (to initialize the cursor, if needed)
    
    precision - the required precision
    
    max - the maximum nodes read (for an exact size)
    
    Returns:
    
    the size, or -1 if unknown
  - copyOf
```
public SourceImpl copyOf()
```
    Returns:
    
    a clone of self. Default implementation in AstElement returns same reference to this.
  - 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 SelectorImpl

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

query

Constructor Detail

SelectorImpl

Method Detail

getSelectorName

getNodeType

matchesAllTypes

getSupertypes

getPrimaryTypes

getMixinTypes

getWildcardColumns

toString

isPrepared

unprepare

prepare

prepare

getExecutionPlan

setQueryConstraint

setOuterJoin

addJoinCondition

execute

getPlan

getIndexCostInfo

createFilter

next

currentPath

currentTree

currentProperty

currentProperty

currentOakProperty

isVirtualRow

getSelector

getScanCount

restrictSelector

getSelectorConstraints

equals

hashCode

getInnerJoinSelectors

isOuterJoinRightHandSide

getQuery

getSize

copyOf

protect

quote

quoteJson

setQuery

normalizePropertyName

normalizePath

convertValueToType

getLocalPath