org.neo4j.kernel.api.impl.index.partition

Class ReadOnlyIndexPartition

java.lang.Object

org.neo4j.kernel.api.impl.index.partition.AbstractIndexPartition

org.neo4j.kernel.api.impl.index.partition.ReadOnlyIndexPartition

All Implemented Interfaces:

Closeable, AutoCloseable

public class ReadOnlyIndexPartition
extends AbstractIndexPartition

Represents a single read only partition of a partitioned lucene index. Read only partition do not support write to index and performs all read operations based on index opened in read only mode.

Method Summary

Modifier and Type	Method and Description
PartitionSearcher	acquireSearcher() Return searcher for requested partition.
void	close()
org.apache.lucene.index.IndexWriter	getIndexWriter() Retrieve index partition writer
void	maybeRefreshBlocking() Refresh partition.
org.neo4j.graphdb.ResourceIterator<File>	snapshot() Retrieve list of consistent Lucene index files for read only partition.

Methods inherited from class org.neo4j.kernel.api.impl.index.partition.AbstractIndexPartition

getDirectory

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getIndexWriter

public org.apache.lucene.index.IndexWriter getIndexWriter()

Description copied from class: AbstractIndexPartition

Retrieve index partition writer

Specified by:

getIndexWriter in class AbstractIndexPartition

Returns:

partition writer

acquireSearcher

public PartitionSearcher acquireSearcher()
                                  throws IOException

Return searcher for requested partition. There is no tracking of acquired searchers, so the expectation is that callers will call close on acquired searchers to release resources.

Specified by:

acquireSearcher in class AbstractIndexPartition

Returns:

partition searcher

Throws:

IOException - if exception happened during searcher acquisition

maybeRefreshBlocking

public void maybeRefreshBlocking()
                          throws IOException

Refresh partition. No-op in read only partition.

Specified by:

maybeRefreshBlocking in class AbstractIndexPartition

Throws:

IOException - if refreshing fails.

close

public void close()
           throws IOException

Throws:

IOException

snapshot

public org.neo4j.graphdb.ResourceIterator<File> snapshot()
                                                  throws IOException

Retrieve list of consistent Lucene index files for read only partition.

Specified by:

snapshot in class AbstractIndexPartition

Returns:

the iterator over index files.

Throws:

IOException - if any IO operation fails.