org.neo4j.kernel.api.impl.index.storage

Class PartitionedIndexStorage

java.lang.Object

org.neo4j.kernel.api.impl.index.storage.PartitionedIndexStorage

public class PartitionedIndexStorage
extends Object

Utility class that manages directory structure for a partitioned lucene index. It is aware of the file system structure of all index related folders, lucene directories and failure storage.

Constructor Summary

Constructors

Constructor and Description
PartitionedIndexStorage(DirectoryFactory directoryFactory, org.neo4j.io.fs.FileSystemAbstraction fileSystem, File rootFolder, String identifier, boolean archiveFailed)

Method Summary

Modifier and Type	Method and Description
void	cleanupFolder(File folder) For the given folder removes the folder itself and all nested folders from both file system and lucene directories.
File	getIndexFolder() Resolves root folder for the given index.
File	getPartitionFolder(int partition) Resolves a folder for the partition with the given index.
String	getStoredIndexFailure() Retrieves stored index failure.
List<File>	listFolders() List all folders in the index folder.
org.apache.lucene.store.Directory	openDirectory(File folder) Opens a lucene directory for the given folder.
Map<File,org.apache.lucene.store.Directory>	openIndexDirectories() Opens all lucene directories contained in the index folder.
void	prepareFolder(File folder) For the given folder removes all nested folders from both file system and lucene directories.
void	reserveIndexFailureStorage() Create a failure storage in the index folder.
void	storeIndexFailure(String failure) Writes index failure into the failure storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

PartitionedIndexStorage

public PartitionedIndexStorage(DirectoryFactory directoryFactory,
                               org.neo4j.io.fs.FileSystemAbstraction fileSystem,
                               File rootFolder,
                               String identifier,
                               boolean archiveFailed)

Method Detail

openDirectory

public org.apache.lucene.store.Directory openDirectory(File folder)
                                                throws IOException

Opens a lucene directory for the given folder.

Parameters:

folder - the folder that denotes a lucene directory.

Returns:

the lucene directory denoted by the given folder.

Throws:

IOException - if directory can't be opened.

getPartitionFolder

public File getPartitionFolder(int partition)

Resolves a folder for the partition with the given index.

Parameters:

partition - the partition index.

Returns:

the folder where partition's lucene directory should be located.

getIndexFolder

public File getIndexFolder()

Resolves root folder for the given index.

Returns:

the folder containing index partition folders.

reserveIndexFailureStorage

public void reserveIndexFailureStorage()
                                throws IOException

Create a failure storage in the index folder.

Throws:

IOException - if failure storage creation fails.

See Also:

FailureStorage.reserveForIndex()

storeIndexFailure

public void storeIndexFailure(String failure)
                       throws IOException

Writes index failure into the failure storage.

Parameters:

failure - the cause of the index failure.

Throws:

IOException - if writing to the failure storage file failed.

See Also:

FailureStorage.storeIndexFailure(String)

getStoredIndexFailure

public String getStoredIndexFailure()

Retrieves stored index failure.

Returns:

index failure as string or null if there is no failure.

See Also:

FailureStorage.loadIndexFailure()

prepareFolder

public void prepareFolder(File folder)
                   throws IOException

For the given folder removes all nested folders from both file system and lucene directories.

Parameters:

folder - the folder to clean up.

Throws:

IOException - if some removal operation fails.

cleanupFolder

public void cleanupFolder(File folder)
                   throws IOException

For the given folder removes the folder itself and all nested folders from both file system and lucene directories.

Parameters:

folder - the folder to remove.

Throws:

IOException - if some removal operation fails.

openIndexDirectories

public Map<File,org.apache.lucene.store.Directory> openIndexDirectories()
                                                                 throws IOException

Opens all lucene directories contained in the index folder.

Returns:

the map from file system directory to the corresponding lucene directory.

Throws:

IOException - if opening of some lucene directory (via DirectoryFactory.open(File)) fails.

listFolders

public List<File> listFolders()

List all folders in the index folder.

Returns:

the list of index partition folders or empty list if index folder is empty.