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

Class WritableIndexPartition

java.lang.Object

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

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

All Implemented Interfaces:

Closeable, AutoCloseable

public class WritableIndexPartition
extends AbstractIndexPartition

Represents a single writable partition of a partitioned lucene index.

See Also:

AbstractIndexPartition

Constructor Summary

Constructors

Constructor and Description
WritableIndexPartition(File partitionFolder, org.apache.lucene.store.Directory directory, org.apache.lucene.index.IndexWriterConfig writerConfig)

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 to make newly inserted data visible for readers.
org.neo4j.graphdb.ResourceIterator<File>	snapshot() Retrieve list of consistent Lucene index files for this 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

Constructor Detail

WritableIndexPartition

public WritableIndexPartition(File partitionFolder,
                              org.apache.lucene.store.Directory directory,
                              org.apache.lucene.index.IndexWriterConfig writerConfig)
                       throws IOException

Throws:

IOException

Method Detail

getIndexWriter

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

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 to make newly inserted data visible for readers.

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 this partition.

Specified by:

snapshot in class AbstractIndexPartition

Returns:

the iterator over index files.

Throws:

IOException - if any IO operation fails.