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

Interface FolderLayout

All Known Implementing Classes:

IndexFolderLayout

public interface FolderLayout

Component that represent on-disk layout for partitioned lucene index.

It's aware how files and partitions located on disk and knows how to map particular partition index into folder. Physically files for index with id indexId will be located in a index root folder indexId with separate sub-folder for each partition. Since each partition is separate lucene index all lucene index files will be located in a corresponding partition folder.

As example for index with 3 partitions we will have following directory structure:

 ...indexId/
    |-- 1
    |   `-- partition index files
    |-- 2
    |   `-- partition index files
    |-- 3
        `-- partition index files
 

Method Summary

Modifier and Type	Method and Description
File	getIndexFolder() Get root folder of partitioned index
File	getPartitionFolder(int partition) Get folder that contain particular partition

Method Detail

getIndexFolder

File getIndexFolder()

Get root folder of partitioned index

Returns:

the file that represent directory where whole index is located

getPartitionFolder

File getPartitionFolder(int partition)

Get folder that contain particular partition

Parameters:

partition - index of partition to get folder for

Returns:

the file that represents directory where partition with given index is located.