com.amazon.carbonado.repo.indexed

Interface IndexEntryAccessor<S extends Storable>

All Superinterfaces:

IndexInfo

public interface IndexEntryAccessor<S extends Storable>
extends IndexInfo

Provides low-level access to index data, which can be used for manual inspection and repair.

Author:

Brian S O'Neill

See Also:

IndexEntryAccessCapability

Method Summary

Methods

Modifier and Type	Method and Description
void	copyFromMaster(Storable indexEntry, S master) Sets all the properties of the given index entry, using the applicable properties of the given master.
void	copyToMasterPrimaryKey(Storable indexEntry, S master) Sets all the primary key properties of the given master, using the applicable properties of the given index entry.
java.util.Comparator<? extends Storable>	getComparator() Returns a comparator for ordering index entries.
Storage<?>	getIndexEntryStorage() Returns the index entry storage.
boolean	isConsistent(Storable indexEntry, S master) Returns true if the properties of the given index entry match those contained in the master, exluding any version property.
void	repair(double desiredSpeed) Repairs the index by inserting missing entries and fixing inconsistencies.

Methods inherited from interface com.amazon.carbonado.capability.IndexInfo

getName, getPropertyDirections, getPropertyNames, isClustered, isUnique

Method Detail

getIndexEntryStorage

Storage<?> getIndexEntryStorage()

Returns the index entry storage.

copyToMasterPrimaryKey

void copyToMasterPrimaryKey(Storable indexEntry,
                          S master)
                            throws FetchException

Sets all the primary key properties of the given master, using the applicable properties of the given index entry.

Parameters:

indexEntry - source of property values

master - master whose primary key properties will be set

Throws:

FetchException

copyFromMaster

void copyFromMaster(Storable indexEntry,
                  S master)
                    throws FetchException

Sets all the properties of the given index entry, using the applicable properties of the given master.

Parameters:

indexEntry - index entry whose properties will be set

master - source of property values

Throws:

FetchException

isConsistent

boolean isConsistent(Storable indexEntry,
                   S master)
                     throws FetchException

Returns true if the properties of the given index entry match those contained in the master, exluding any version property. This will always return true after a call to copyFromMaster.

Parameters:

indexEntry - index entry whose properties will be tested

master - source of property values

Throws:

FetchException

repair

void repair(double desiredSpeed)
            throws RepositoryException

Repairs the index by inserting missing entries and fixing inconsistencies.

Parameters:

desiredSpeed - throttling parameter - 1.0 = full speed, 0.5 = half speed, 0.1 = one-tenth speed, etc

Throws:

RepositoryException

getComparator

java.util.Comparator<? extends Storable> getComparator()

Returns a comparator for ordering index entries.