org.neo4j.graphdb.index

Interface IndexImplementation

public interface IndexImplementation

An index provider which can create and give access to index transaction state and means of applying updates to indexes it provides. An IndexImplementation is typically tied to one implementation, f.ex. lucene, http://lucene.apache.org/java.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	configMatches(Map<String,String> storedConfig, Map<String,String> config)
Map<String,String>	fillInDefaults(Map<String,String> config) Fills in default configuration parameters for indexes provided from this index provider.
void	force()
ResourceIterator<File>	listStoreFiles() Lists store files that this index provider manages.
org.neo4j.kernel.impl.transaction.command.NeoCommandHandler	newApplier(boolean recovery)
LegacyIndexProviderTransaction	newTransaction(IndexCommandFactory commandFactory) Returns a LegacyIndexProviderTransaction that keeps transaction state for all indexes for a given provider in a transaction.

Method Detail

newTransaction

LegacyIndexProviderTransaction newTransaction(IndexCommandFactory commandFactory)

Returns a LegacyIndexProviderTransaction that keeps transaction state for all indexes for a given provider in a transaction.

Parameters:

configuration - that return a legacy index SPI for.

Returns:

a LegacyIndexSPI which represents a type of index suitable for the given configuration.

newApplier

org.neo4j.kernel.impl.transaction.command.NeoCommandHandler newApplier(boolean recovery)

Returns:

an index applier that will get notifications about commands to apply.

fillInDefaults

Map<String,String> fillInDefaults(Map<String,String> config)

Fills in default configuration parameters for indexes provided from this index provider. This method will also validate the the configuration is valid to be used as index configuration for this provider.

Parameters:

config - the configuration map to complete with defaults.

Returns:

a Map filled with decent defaults for an index from this index provider.

configMatches

boolean configMatches(Map<String,String> storedConfig,
                    Map<String,String> config)

force

void force()

listStoreFiles

ResourceIterator<File> listStoreFiles()
                                      throws IOException

Lists store files that this index provider manages. After this call has been made and until the returned ResourceIterator has been closed this index provider must guarantee that the list of files stay intact. The files in the list can change, but no files may be deleted or added during this period.

Throws:

IOException