Uses of Class
com.amazon.carbonado.info.StorableIndex

Packages that use StorableIndex

Package	Description
com.amazon.carbonado.info	Introspection support for Storables.
com.amazon.carbonado.qe	Support for implementing a Query Engine.
com.amazon.carbonado.raw	Provides support for repositories that encode/decode storables in a raw binary format.

Uses of StorableIndex in com.amazon.carbonado.info

Methods in com.amazon.carbonado.info that return StorableIndex

Modifier and Type	Method and Description
StorableIndex<S>	StorableIndex.addProperty(StorableProperty<S> property, Direction direction) Returns a StorableIndex with the given property added.
StorableIndex<S>	StorableIndex.clustered(boolean clustered) Returns a StorableIndex instance which is clustered or not.
StorableIndex<S>	StorableInfo.getIndex(int index) Returns a specific index for the Storable.
StorableIndex<S>[]	StorableInfo.getIndexes() Returns a new array with all the indexes in it.
static <S extends Storable> StorableIndex<S>	StorableIndex.parseNameDescriptor(java.lang.String desc, StorableInfo<S> info) Parses an index descriptor and returns an index object.
StorableIndex<S>	StorableIndex.reverse() Returns a StorableIndex instance with all the properties reversed.
StorableIndex<S>	StorableIndex.setDefaultDirection(Direction direction) Returns a StorableIndex instance with all unspecified directions set to the given direction.
StorableIndex<S>	StorableIndex.unique(boolean unique) Returns a StorableIndex instance which is unique or not.
StorableIndex<S>	StorableIndex.uniquify(StorableKey<S> key) Returns a StorableIndex which is unique, possibly by appending properties from the given key.

Uses of StorableIndex in com.amazon.carbonado.qe

Methods in com.amazon.carbonado.qe that return StorableIndex

Modifier and Type	Method and Description
StorableIndex<S>	StorableIndexSet.findKeyIndex(StorableKey<S> key) Finds the best index to represent the given key.
StorableIndex<S>	StorableIndexSet.findPrimaryKeyIndex(StorableInfo<S> info) Finds the best index to represent the primary key.
StorableIndex<?>	IndexedQueryAnalyzer.Result.getForeignIndex() Returns the foreign index that was selected, or null if a local index was selected.
StorableIndex<S>	IndexedQueryAnalyzer.Result.getLocalIndex() Returns the local index that was selected, or null if a foreign index was selected.

Methods in com.amazon.carbonado.qe that return types with arguments of type StorableIndex

Modifier and Type	Method and Description
java.util.Collection<StorableIndex<S>>	StorageAccess.getAllIndexes() Returns all the available indexes.

Methods in com.amazon.carbonado.qe with parameters of type StorableIndex

Modifier and Type	Method and Description
static <S extends Storable> FilteringScore<S>	FilteringScore.evaluate(StorableIndex<S> index, Filter<S> filter) Evaluates the given index for its filtering capabilities against the given filter.
static <S extends Storable> CompositeScore<S>	CompositeScore.evaluate(StorableIndex<S> index, Filter<S> filter, OrderingList<S> ordering) Evaluates the given index for its filtering and ordering capabilities against the given filter and order-by properties.
static <S extends Storable> OrderingScore<S>	OrderingScore.evaluate(StorableIndex<S> index, Filter<S> filter, OrderingList<S> ordering) Evaluates the given index for its ordering capabilities against the given filter and order-by properties.
Cursor<S>	IndexedQueryExecutor.Support.fetchFromIndexEntryQuery(StorableIndex<S> index, Query<?> indexEntryQuery) Fetch Storables referenced by the given index entry query.
Cursor<S>	IndexedQueryExecutor.Support.fetchFromIndexEntryQuery(StorableIndex<S> index, Query<?> indexEntryQuery, Query.Controller controller) Fetch Storables referenced by the given index entry query.
Cursor<S>	KeyQueryExecutor.Support.fetchOne(StorableIndex<S> index, java.lang.Object[] identityValues) Select at most one Storable referenced by an index.
Cursor<S>	KeyQueryExecutor.Support.fetchOne(StorableIndex<S> index, java.lang.Object[] identityValues, Query.Controller controller) Select at most one Storable referenced by an index.
Cursor<S>	IndexedQueryExecutor.Support.fetchSubset(StorableIndex<S> index, java.lang.Object[] identityValues, BoundaryType rangeStartBoundary, java.lang.Object rangeStartValue, BoundaryType rangeEndBoundary, java.lang.Object rangeEndValue, boolean reverseRange, boolean reverseOrder) Perform an index scan of a subset of Storables referenced by an index.
Cursor<S>	IndexedQueryExecutor.Support.fetchSubset(StorableIndex<S> index, java.lang.Object[] identityValues, BoundaryType rangeStartBoundary, java.lang.Object rangeStartValue, BoundaryType rangeEndBoundary, java.lang.Object rangeEndValue, boolean reverseRange, boolean reverseOrder, Query.Controller controller) Perform an index scan of a subset of Storables referenced by an index.
Query<?>	IndexedQueryExecutor.Support.indexEntryQuery(StorableIndex<S> index) Returns an open query if the given index supports query access.
Storage<S>	StorageAccess.storageDelegate(StorableIndex<S> index) If the given index is not directly supported by storage, queries should be delegated.

Constructors in com.amazon.carbonado.qe with parameters of type StorableIndex

Constructor and Description
IndexedQueryExecutor(IndexedQueryExecutor.Support<S> support, StorableIndex<S> index, CompositeScore<S> score)
KeyQueryExecutor(KeyQueryExecutor.Support<S> support, StorableIndex<S> index, FilteringScore<S> score)

Uses of StorableIndex in com.amazon.carbonado.raw

Methods in com.amazon.carbonado.raw that return StorableIndex

Modifier and Type	Method and Description
StorableIndex<S>	CustomStorableCodec.buildPkIndex(java.lang.String... propertyNames) Convenient way to define the clustered primary key index descriptor.
StorableIndex<S>	StorableCodec.getPrimaryKeyIndex() Returns the sequence and directions of properties that make up the primary key.
protected StorableIndex<S>	GenericEncodingStrategy.getPrimaryKeyIndex() Returns all key properties in the form of an index.
StorableIndex<S>	GenericStorableCodec.getPrimaryKeyIndex()

Methods in com.amazon.carbonado.raw with parameters of type StorableIndex

Modifier and Type	Method and Description
<S extends Storable> CustomStorableCodec<S>	CustomStorableCodecFactory.createCodec(java.lang.Class<S> type, StorableIndex pkIndex, boolean isMaster, Layout layout)
<S extends Storable> StorableCodec<S>	StorableCodecFactory.createCodec(java.lang.Class<S> type, StorableIndex pkIndex, boolean isMaster, Layout layout)
<S extends Storable> GenericStorableCodec<S>	GenericStorableCodecFactory.createCodec(java.lang.Class<S> type, StorableIndex pkIndex, boolean isMaster, Layout layout)
<S extends Storable> CustomStorableCodec<S>	CustomStorableCodecFactory.createCodec(java.lang.Class<S> type, StorableIndex pkIndex, boolean isMaster, Layout layout, RawSupport support)
<S extends Storable> StorableCodec<S>	StorableCodecFactory.createCodec(java.lang.Class<S> type, StorableIndex pkIndex, boolean isMaster, Layout layout, RawSupport support)
<S extends Storable> GenericStorableCodec<S>	GenericStorableCodecFactory.createCodec(java.lang.Class<S> type, StorableIndex pkIndex, boolean isMaster, Layout layout, RawSupport support)
protected <S extends Storable> GenericEncodingStrategy<S>	GenericStorableCodecFactory.createStrategy(java.lang.Class<S> type, StorableIndex<S> pkIndex) Override to return a different EncodingStrategy.
protected <S extends Storable> GenericEncodingStrategy<S>	CompressedStorableCodecFactory.createStrategy(java.lang.Class<S> type, StorableIndex<S> pkIndex, LayoutOptions options)
protected <S extends Storable> GenericEncodingStrategy<S>	GenericStorableCodecFactory.createStrategy(java.lang.Class<S> type, StorableIndex<S> pkIndex, LayoutOptions options) Override to return a different EncodingStrategy.

Constructors in com.amazon.carbonado.raw with parameters of type StorableIndex

Constructor and Description
CompressedEncodingStrategy(java.lang.Class<S> type, StorableIndex<S> pkIndex, CompressionType compressionType)
GenericEncodingStrategy(java.lang.Class<S> type, StorableIndex<S> pkIndex)
GenericEncodingStrategy(java.lang.Class<S> type, StorableIndex<S> pkIndex, int keyPrefixPadding, int keySuffixPadding, int dataPrefixPadding, int dataSuffixPadding)