public interface QueryIndex
NodeKey
s that satisfy a particular
portion of a query.
Each time ModeShape uses this index, it calls the filter(Filter)
method to obtain an QueryIndex.Operation
instance that
ModeShape will then use to access
the batches of node keys that satisfy the
given QueryIndex.Filter
. Note that once an QueryIndex.Operation
is obtained, it may not be called if the query is cancelled before
this index is needed.
Modifier and Type | Interface and Description |
---|---|
static interface |
QueryIndex.Filter
The filter containing a set of constraints.
|
static interface |
QueryIndex.Operation
A potentially executable stateful operation that returns the set of nodes that satisfies the constraints supplied when the
operation is
created . |
static interface |
QueryIndex.ResultWriter
A writer passed by ModeShape to a
QueryIndex.Operation instance when the query engine needs additional results for the query. |
Modifier and Type | Method and Description |
---|---|
QueryIndex.Operation |
filter(QueryIndex.Filter filter)
Return a
QueryIndex.Operation instance that ModeShape can when it actually wants the results. |
String |
getName()
Get the name of this index.
|
String |
getProviderName()
Get the name of the
QueryIndexProvider that owns this index. |
boolean |
supportsFullTextConstraints()
Return whether this index can use full-text search constraints.
|
String getProviderName()
QueryIndexProvider
that owns this index.name
; never nullString getName()
boolean supportsFullTextConstraints()
QueryIndex.Operation filter(QueryIndex.Filter filter)
QueryIndex.Operation
instance that ModeShape can when it actually wants the results. Note that this method should
return quickly, since ideally no work is really done other than instantiating and populating the QueryIndex.Operation
instance. Instead, all work should be performed when the resulting Operation's
Operation#getNextBatch(ResultWriter, int)
method is called.filter
- the filter to be applied by this index; never nullCopyright © 2008-2014 JBoss, a division of Red Hat. All Rights Reserved.