org.modeshape.jcr.query.engine

Class IndexPlan.StandardIndexPlanner

java.lang.Object

org.modeshape.jcr.spi.index.provider.IndexPlanner

org.modeshape.jcr.query.engine.IndexPlan.StandardIndexPlanner

Enclosing class:

IndexPlan

@Immutable
public static class IndexPlan.StandardIndexPlanner
extends IndexPlanner

Field Summary

Fields

Modifier and Type	Field and Description
static IndexPlanner	INSTANCE

Constructor Summary

Constructors

Constructor and Description
IndexPlan.StandardIndexPlanner()

Method Summary

Methods

Modifier and Type	Method and Description
void	applyIndexes(QueryContext context, SelectorName selector, List<Constraint> andedConstraints, Iterable<IndexDefinition> indexesOnSelector, IndexCollector indexes) Examine the supplied constraints applied to the given selector in a query, and record in the supplied IndexCollector any and all indexes in this provider that can be used in this query.

Methods inherited from class org.modeshape.jcr.spi.index.provider.IndexPlanner

both

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final IndexPlanner INSTANCE

Constructor Detail

IndexPlan.StandardIndexPlanner

public IndexPlan.StandardIndexPlanner()

Method Detail

applyIndexes

public void applyIndexes(QueryContext context,
                SelectorName selector,
                List<Constraint> andedConstraints,
                Iterable<IndexDefinition> indexesOnSelector,
                IndexCollector indexes)

Description copied from class: IndexPlanner

Examine the supplied constraints applied to the given selector in a query, and record in the supplied IndexCollector any and all indexes in this provider that can be used in this query.

Specified by:

applyIndexes in class IndexPlanner

Parameters:

context - the context in which the query is being executed, provided by ModeShape; never null

selector - the name of the selector against which all of the andedConstraints are to be applied; never null

andedConstraints - the immutable list of Constraint instances that are all AND-ed and applied against the selector; never null but possibly empty

indexesOnSelector - the available index definitions that apply to the node type identified by the named selector; may be null if there are no indexes defined

indexes - the list provided by the caller into which this method should add the index(es), if any, that the query engine might use to satisfy the relevant portion of the query; never null