org.neo4j.storageengine.api.schema

Interface IndexReader

All Superinterfaces:

AutoCloseable, org.neo4j.graphdb.Resource

public interface IndexReader
extends org.neo4j.graphdb.Resource

Reader for an index. Must honor repeatable reads, which means that if a lookup is executed multiple times the same result set must be returned.

Field Summary

Fields

Modifier and Type	Field and Description
static IndexReader	EMPTY

Method Summary

Modifier and Type	Method and Description
long	countIndexedNodes(long nodeId, org.neo4j.values.storable.Value... propertyValues)
IndexSampler	createSampler()
boolean	hasFullNumberPrecision()
org.neo4j.collection.primitive.PrimitiveLongIterator	query(org.neo4j.kernel.api.schema.IndexQuery... predicates) Queries the index for the given IndexQuery predicates.

Methods inherited from interface org.neo4j.graphdb.Resource

close

Field Detail

EMPTY

static final IndexReader EMPTY

Method Detail

countIndexedNodes

long countIndexedNodes(long nodeId,
                       org.neo4j.values.storable.Value... propertyValues)

Parameters:

nodeId - node id to match.

propertyValues - property values to match.

Returns:

number of index entries for the given nodeId and propertyValues.

createSampler

IndexSampler createSampler()

query

org.neo4j.collection.primitive.PrimitiveLongIterator query(org.neo4j.kernel.api.schema.IndexQuery... predicates)
                                                    throws org.neo4j.kernel.api.exceptions.index.IndexNotApplicableKernelException

Queries the index for the given IndexQuery predicates.

Parameters:

predicates - the predicates to query for.

Returns:

the matching entity IDs.

Throws:

org.neo4j.kernel.api.exceptions.index.IndexNotApplicableKernelException

hasFullNumberPrecision

boolean hasFullNumberPrecision()

Returns:

whether or not this reader will only return 100% matching results from query(IndexQuery...) when calling with predicates involving numbers, such as IndexQuery.exact(int, Object) w/ a Number or IndexQuery.range(int, Number, boolean, Number, boolean). If false is returned this means that the caller of query(IndexQuery...) will have to do additional filtering, double-checking of actual property values, externally.