org.neo4j.kernel.api.index

Interface IndexPopulator

All Known Implementing Classes:

IndexPopulator.Adapter

public interface IndexPopulator

Used for initial population of an index.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IndexPopulator.Adapter

Method Summary

Methods

Modifier and Type	Method and Description
void	add(long nodeId, Object propertyValue) Called when initially populating an index over existing data.
void	close(boolean populationCompletedSuccessfully) Close this populator and releases any resources related to it.
void	create() Remove all data in the index and paves the way for populating an index.
void	drop() Closes and deletes this index.
void	markAsFailed(String failure) Called then a population failed.
void	update(Iterable<NodePropertyUpdate> updates) Apply a set of changes to this index, generally this will be a set of changes from a transaction.

Method Detail

create

void create()
            throws IOException

Remove all data in the index and paves the way for populating an index.

Throws:

IOException

drop

void drop()
          throws IOException

Closes and deletes this index.

Throws:

IOException

add

void add(long nodeId,
       Object propertyValue)
         throws IndexEntryConflictException,
                IOException

Called when initially populating an index over existing data. Guaranteed to be called by the same thread every time. All data coming in here is guaranteed to not have been added to this index previously, by any method.

Parameters:

nodeId - node id to index.

propertyValue - property value for the entry to index.

Throws:

IndexEntryConflictException

IOException

update

void update(Iterable<NodePropertyUpdate> updates)
            throws IndexEntryConflictException,
                   IOException

Apply a set of changes to this index, generally this will be a set of changes from a transaction.

Throws:

IndexEntryConflictException

IOException

close

void close(boolean populationCompletedSuccessfully)
           throws IOException

Close this populator and releases any resources related to it. If populationCompletedSuccessfully is true then it must mark this index as InternalIndexState.ONLINE so that future invocations of its parent SchemaIndexProvider.getInitialState(long) also returns InternalIndexState.ONLINE.

Throws:

IOException

markAsFailed

void markAsFailed(String failure)
                  throws IOException

Called then a population failed. The failure string should be stored for future retrieval by SchemaIndexProvider.getPopulationFailure(long). Called before close(boolean) if there was a failure during population.

Parameters:

failure - the description of the failure.

Throws:

IOException - if marking failed.