public interface Index
NodeKey
s that satisfy a particular
portion of a query.
Each time ModeShape uses this index, it calls the filter(IndexFilter)
method to obtain an Index.Operation
instance that
ModeShape will then use to access
the batches of node keys that satisfy the
given IndexFilter
. Note that once an Index.Operation
is obtained, it may not be called if the query is cancelled before
this index is needed.
IndexProvider.getIndex(String)
Modifier and Type | Interface and Description |
---|---|
static interface |
Index.Operation
A potentially executable stateful operation that returns the set of nodes that satisfies the constraints supplied when the
operation is
created . |
Modifier and Type | Method and Description |
---|---|
Index.Operation |
filter(IndexFilter filter)
Return a
Index.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
IndexProvider that owns this index. |
boolean |
supportsFullTextConstraints()
Return whether this index can use full-text search constraints.
|
String getProviderName()
IndexProvider
that owns this index.name
; never nullString getName()
boolean supportsFullTextConstraints()
Index.Operation filter(IndexFilter filter)
Index.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 Index.Operation
instance. Instead, all work should be performed when the resulting Operation's
Index.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.