org.modeshape.jcr.spi.index.provider

Interface Filter

All Known Subinterfaces:

Index, ManagedIndex, ProvidedIndex<T>

All Known Implementing Classes:

DefaultManagedIndex, EsIndex, LocalIndex, LuceneIndex

public interface Filter

A simple filter that takes constraints as input and returns a results object that lazily returns (in batches) those nodes that satisfy the constraints.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Filter.Results The results of a filter(IndexConstraints) operation that contains the nodes that satisfy the supplied constraints.

Method Summary

Modifier and Type	Method and Description
Filter.Results	filter(IndexConstraints constraints) Return a Filter.Results instance from which ModeShape can obtain the nodes that satisfy the supplied constraints.

Method Detail

filter

Filter.Results filter(IndexConstraints constraints)

Return a Filter.Results instance from which ModeShape can obtain the nodes that satisfy the supplied constraints. This method should return quickly, since no work (or at least very little work) should be done. All of the work should be performed when the Filter.Results.getNextBatch(ResultWriter, int) method is called on the results.

Parameters:

constraints - the constraints to be applied by this index; never null

Returns:

the batched node keys; never null