org.neo4j.kernel.api.impl.index

Class ReadOnlyAbstractDatabaseIndex<T extends AbstractLuceneIndex>

java.lang.Object

org.neo4j.kernel.api.impl.index.ReadOnlyAbstractDatabaseIndex<T>

Type Parameters:

T - - particular index implementation

All Implemented Interfaces:

Closeable, AutoCloseable, DatabaseIndex

Direct Known Subclasses:

ReadOnlyDatabaseLabelScanIndex, ReadOnlyDatabaseSchemaIndex

public abstract class ReadOnlyAbstractDatabaseIndex<T extends AbstractLuceneIndex>
extends Object
implements DatabaseIndex

Read only lucene index representation that wraps provided index implementation and allow read only operations only on top of it.

Constructor Summary

Constructors

Constructor and Description
ReadOnlyAbstractDatabaseIndex(T luceneIndex)

Method Summary

Modifier and Type	Method and Description
LuceneAllDocumentsReader	allDocumentsReader() Creates an iterable over all documents in all partitions.
void	close()
void	create() Creates new index.
void	drop() Close index and deletes all it's partitions.
boolean	exists() Check lucene index existence within all allocated partitions.
void	flush() Commits all index partitions.
List<AbstractIndexPartition>	getPartitions() Get index partitions
boolean	isOpen() Check if index is open or not
boolean	isReadOnly() Check if index is opened in read only mode
boolean	isValid() Verify state of the index.
void	maybeRefreshBlocking() Refresh all partitions to make newly inserted data visible for readers.
void	open() Open index with all allocated partitions.
org.neo4j.graphdb.ResourceIterator<File>	snapshot() Snapshot of all file in all index partitions.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadOnlyAbstractDatabaseIndex

public ReadOnlyAbstractDatabaseIndex(T luceneIndex)

Method Detail

create

public void create()
            throws IOException

Creates new index. As part of creation process index will allocate all required folders, index failure storage and will create its first partition.

Index creation do not automatically open it. To be able to use index please open it first.

Specified by:

create in interface DatabaseIndex

Throws:

IOException

open

public void open()
          throws IOException

Open index with all allocated partitions.

Specified by:

open in interface DatabaseIndex

Throws:

IOException

isOpen

public boolean isOpen()

Check if index is open or not

Specified by:

isOpen in interface DatabaseIndex

Returns:

true if index is open

isReadOnly

public boolean isReadOnly()

Check if index is opened in read only mode

Specified by:

isReadOnly in interface DatabaseIndex

Returns:

true if index open in rad only mode

exists

public boolean exists()
               throws IOException

Check lucene index existence within all allocated partitions.

Specified by:

exists in interface DatabaseIndex

Returns:

true if index exist in all partitions, false when index is empty or does not exist

Throws:

IOException

isValid

public boolean isValid()

Verify state of the index. If index is already open and in use method assume that index is valid since lucene already operating with it, otherwise necessary checks perform.

Specified by:

isValid in interface DatabaseIndex

Returns:

true if lucene confirm that index is in valid clean state or index is already open.

drop

public void drop()
          throws IOException

Close index and deletes all it's partitions.

Specified by:

drop in interface DatabaseIndex

Throws:

IOException

flush

public void flush()
           throws IOException

Commits all index partitions.

Specified by:

flush in interface DatabaseIndex

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

allDocumentsReader

public LuceneAllDocumentsReader allDocumentsReader()

Creates an iterable over all documents in all partitions.

Specified by:

allDocumentsReader in interface DatabaseIndex

Returns:

LuceneAllDocumentsReader over all documents

snapshot

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

Snapshot of all file in all index partitions.

Specified by:

snapshot in interface DatabaseIndex

Returns:

iterator over all index files.

Throws:

IOException

See Also:

WritableIndexSnapshotFileIterator

maybeRefreshBlocking

public void maybeRefreshBlocking()
                          throws IOException

Refresh all partitions to make newly inserted data visible for readers.

Specified by:

maybeRefreshBlocking in interface DatabaseIndex

Throws:

IOException

getPartitions

public List<AbstractIndexPartition> getPartitions()

Get index partitions

Specified by:

getPartitions in interface DatabaseIndex

Returns:

list of index partition