com.amazon.carbonado.capability

Interface IndexInfo

All Known Subinterfaces:

IndexEntryAccessor<S>

All Known Implementing Classes:

IndexInfoImpl

public interface IndexInfo

General information about an index defined in a Storage.

IndexInfo instances are thread-safe and immutable.

Author:

Brian S O'Neill

See Also:

IndexInfoCapability

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getName() Returns the name of this index, or null if not applicable.
Direction[]	getPropertyDirections() Returns the directions of all the properties in this index.
java.lang.String[]	getPropertyNames() Returns the properties in this index.
boolean	isClustered() Returns true if index is clustered, which means it defines the physical ordering of storables.
boolean	isUnique() Returns true if index entries are unique.

Method Detail

getName

java.lang.String getName()

Returns the name of this index, or null if not applicable.

isUnique

boolean isUnique()

Returns true if index entries are unique.

isClustered

boolean isClustered()

Returns true if index is clustered, which means it defines the physical ordering of storables.

getPropertyNames

java.lang.String[] getPropertyNames()

Returns the properties in this index. The array might be empty, but it is never null. The array is a copy, and so it may be safely modified.

getPropertyDirections

Direction[] getPropertyDirections()

Returns the directions of all the properties in this index. The length of the array matches the length returned by getPropertyNames(). The array is a copy, and so it may be safely modified.