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

Class AbstractIndexPartition

java.lang.Object

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

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ReadOnlyIndexPartition, WritableIndexPartition

public abstract class AbstractIndexPartition
extends Object
implements Closeable

Represents a single partition of a partitioned lucene index. Each partition is a separate Lucene index. Contains and manages lifecycle of the corresponding Directory, writer and SearcherManager.

Constructor Summary

Constructors

Constructor and Description
AbstractIndexPartition(File partitionFolder, org.apache.lucene.store.Directory directory)

Method Summary

Modifier and Type	Method and Description
abstract PartitionSearcher	acquireSearcher() Return searcher for requested partition.
org.apache.lucene.store.Directory	getDirectory() Retrieve index partition directory
abstract org.apache.lucene.index.IndexWriter	getIndexWriter() Retrieve index partition writer
abstract void	maybeRefreshBlocking() Refresh partition to make newly inserted data visible for readers.
abstract org.neo4j.graphdb.ResourceIterator<File>	snapshot() Retrieve list of consistent Lucene index files for this partition.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

AbstractIndexPartition

public AbstractIndexPartition(File partitionFolder,
                              org.apache.lucene.store.Directory directory)

Method Detail

getDirectory

public org.apache.lucene.store.Directory getDirectory()

Retrieve index partition directory

Returns:

partition directory

getIndexWriter

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

Retrieve index partition writer

Returns:

partition writer

acquireSearcher

public abstract 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.

Returns:

partition searcher

Throws:

IOException - if exception happened during searcher acquisition

maybeRefreshBlocking

public abstract void maybeRefreshBlocking()
                                   throws IOException

Refresh partition to make newly inserted data visible for readers.

Throws:

IOException - if refreshing fails.

snapshot

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

Retrieve list of consistent Lucene index files for this partition.

Returns:

the iterator over index files.

Throws:

IOException - if any IO operation fails.