org.apache.asterix.metadata.entities

Class Index

java.lang.Object

org.apache.asterix.metadata.entities.Index

All Implemented Interfaces:

Serializable, Comparable<Index>, IMetadataEntity

public class Index
extends Object
implements IMetadataEntity, Comparable<Index>

Metadata describing an index.

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.asterix.metadata.api.IMetadataEntity

PENDING_ADD_OP, PENDING_DROP_OP, PENDING_NO_OP

Constructor Summary

Constructors

Constructor and Description
Index(String dataverseName, String datasetName, String indexName, DatasetConfig.IndexType indexType, List<List<String>> keyFieldNames, List<IAType> keyFieldTypes, boolean enforceKeyFields, boolean isPrimaryIndex, int pendingOp)
Index(String dataverseName, String datasetName, String indexName, DatasetConfig.IndexType indexType, List<List<String>> keyFieldNames, List<IAType> keyFieldTypes, int gramLength, boolean enforceKeyFields, boolean isPrimaryIndex, int pendingOp)

Method Summary

Methods

Modifier and Type	Method and Description
Object	addToCache(MetadataCache cache)
int	compareTo(Index otherIndex)
Object	dropFromCache(MetadataCache cache)
boolean	equals(Object other)
String	getDatasetName()
String	getDataverseName()
int	getGramLength()
String	getIndexName()
DatasetConfig.IndexType	getIndexType()
List<List<String>>	getKeyFieldNames()
List<IAType>	getKeyFieldTypes()
static org.apache.hyracks.algebricks.common.utils.Pair<IAType,Boolean>	getNonNullableKeyFieldType(List<String> expr, ARecordType recType)
static org.apache.hyracks.algebricks.common.utils.Pair<IAType,Boolean>	getNonNullableOpenFieldType(IAType fieldType, List<String> fieldName, ARecordType recType)
static org.apache.hyracks.algebricks.common.utils.Pair<IAType,Boolean>	getNonNullableType(IAType keyType)
int	getPendingOp()
int	hashCode()
boolean	isEnforcingKeyFileds()
boolean	isPrimaryIndex()
boolean	isSecondaryIndex()
void	setPendingOp(int pendingOp)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Index

public Index(String dataverseName,
     String datasetName,
     String indexName,
     DatasetConfig.IndexType indexType,
     List<List<String>> keyFieldNames,
     List<IAType> keyFieldTypes,
     int gramLength,
     boolean enforceKeyFields,
     boolean isPrimaryIndex,
     int pendingOp)

Index

public Index(String dataverseName,
     String datasetName,
     String indexName,
     DatasetConfig.IndexType indexType,
     List<List<String>> keyFieldNames,
     List<IAType> keyFieldTypes,
     boolean enforceKeyFields,
     boolean isPrimaryIndex,
     int pendingOp)

Method Detail

getDataverseName

public String getDataverseName()

getDatasetName

public String getDatasetName()

getIndexName

public String getIndexName()

getKeyFieldNames

public List<List<String>> getKeyFieldNames()

getKeyFieldTypes

public List<IAType> getKeyFieldTypes()

getGramLength

public int getGramLength()

getIndexType

public DatasetConfig.IndexType getIndexType()

isPrimaryIndex

public boolean isPrimaryIndex()

isEnforcingKeyFileds

public boolean isEnforcingKeyFileds()

getPendingOp

public int getPendingOp()

setPendingOp

public void setPendingOp(int pendingOp)

isSecondaryIndex

public boolean isSecondaryIndex()

getNonNullableType

public static org.apache.hyracks.algebricks.common.utils.Pair<IAType,Boolean> getNonNullableType(IAType keyType)
                                                                                          throws org.apache.hyracks.algebricks.common.exceptions.AlgebricksException

Throws:

org.apache.hyracks.algebricks.common.exceptions.AlgebricksException

getNonNullableOpenFieldType

public static org.apache.hyracks.algebricks.common.utils.Pair<IAType,Boolean> getNonNullableOpenFieldType(IAType fieldType,
                                                                                          List<String> fieldName,
                                                                                          ARecordType recType)
                                                                                                   throws org.apache.hyracks.algebricks.common.exceptions.AlgebricksException

Throws:

org.apache.hyracks.algebricks.common.exceptions.AlgebricksException

getNonNullableKeyFieldType

public static org.apache.hyracks.algebricks.common.utils.Pair<IAType,Boolean> getNonNullableKeyFieldType(List<String> expr,
                                                                                         ARecordType recType)
                                                                                                  throws org.apache.hyracks.algebricks.common.exceptions.AlgebricksException

Throws:

org.apache.hyracks.algebricks.common.exceptions.AlgebricksException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

addToCache

public Object addToCache(MetadataCache cache)

Specified by:

addToCache in interface IMetadataEntity

dropFromCache

public Object dropFromCache(MetadataCache cache)

Specified by:

dropFromCache in interface IMetadataEntity

compareTo

public int compareTo(Index otherIndex)

Specified by:

compareTo in interface Comparable<Index>