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
org.neo4j.collection.primitive.PrimitiveLongIterator	containsString(String exactTerm) Searches this index for string values containing the exact search string.
long	countIndexedNodes(long nodeId, Object propertyValue)
IndexSampler	createSampler()
org.neo4j.collection.primitive.PrimitiveLongIterator	endsWith(String suffix) Searches this index for string values ending with the suffix search string.
org.neo4j.collection.primitive.PrimitiveLongIterator	rangeSeekByNumberInclusive(Number lower, Number upper) Searches this index for numerics values between lower and upper.
org.neo4j.collection.primitive.PrimitiveLongIterator	rangeSeekByPrefix(String prefix) Searches this index for string values starting with prefix.
org.neo4j.collection.primitive.PrimitiveLongIterator	rangeSeekByString(String lower, boolean includeLower, String upper, boolean includeUpper) Searches this index for string values between lower and upper.
org.neo4j.collection.primitive.PrimitiveLongIterator	scan() Scans this index returning all nodes.
org.neo4j.collection.primitive.PrimitiveLongIterator	seek(Object value) Searches this index for a certain value.

Methods inherited from interface org.neo4j.graphdb.Resource

close

Field Detail

EMPTY

static final IndexReader EMPTY

Method Detail

seek

org.neo4j.collection.primitive.PrimitiveLongIterator seek(Object value)

Searches this index for a certain value.

Parameters:

value - property value to search for.

Returns:

ids of matching nodes.

rangeSeekByNumberInclusive

org.neo4j.collection.primitive.PrimitiveLongIterator rangeSeekByNumberInclusive(Number lower,
                                                                                Number upper)

Searches this index for numerics values between lower and upper.

Parameters:

lower - lower numeric bound of search (inclusive).

upper - upper numeric bound of search (inclusive).

Returns:

ids of matching nodes.

rangeSeekByString

org.neo4j.collection.primitive.PrimitiveLongIterator rangeSeekByString(String lower,
                                                                       boolean includeLower,
                                                                       String upper,
                                                                       boolean includeUpper)

Searches this index for string values between lower and upper.

Parameters:

lower - lower numeric bound of search.

includeLower - whether or not lower bound is inclusive.

upper - upper numeric bound of search.

includeUpper - whether or not upper bound is inclusive.

Returns:

ids of matching nodes.

rangeSeekByPrefix

org.neo4j.collection.primitive.PrimitiveLongIterator rangeSeekByPrefix(String prefix)

Searches this index for string values starting with prefix.

Parameters:

prefix - prefix that matching strings must start with.

Returns:

ids of matching nodes.

scan

org.neo4j.collection.primitive.PrimitiveLongIterator scan()

Scans this index returning all nodes.

Returns:

node ids in index.

containsString

org.neo4j.collection.primitive.PrimitiveLongIterator containsString(String exactTerm)

Searches this index for string values containing the exact search string.

Parameters:

exactTerm - the exact string to search for in the index

Returns:

ids of matching nodes.

endsWith

org.neo4j.collection.primitive.PrimitiveLongIterator endsWith(String suffix)

Searches this index for string values ending with the suffix search string.

Parameters:

suffix - the string to search for in the index

Returns:

ids of matching nodes.

countIndexedNodes

long countIndexedNodes(long nodeId,
                       Object propertyValue)

Parameters:

nodeId - node if to match.

propertyValue - property value to match.

Returns:

number of index entries for the given nodeId and propertyValue.

createSampler

IndexSampler createSampler()