Package com.mapr.fs.tables.impl

Class ExtIndexDescImpl

java.lang.Object

com.mapr.fs.tables.impl.ExtIndexDescImpl

All Implemented Interfaces:

ExtIndexDesc

public final class ExtIndexDescImpl
extends Object
implements ExtIndexDesc

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ExtIndexDescImpl.Builder

Method Summary

Modifier and Type	Method	Description
String	getCluster()	Returns the cluster identifier of the system.
String	getConnectionString()	For the external system that supports it, returns the connection string, null for native secondary indexes.
Collection<ExtIndexFieldDesc>	getCoveredFields()	Returns a collection of covered fields that are stored in this Index but are not indexed.
List<ExtIndexFieldDesc>	getIndexedFields()	Returns an ordered list of field descriptors which are indexed.
String	getIndexFid()	Returns secondary index table FID.
String	getIndexName()	Returns the fully qualified, canonical name of the index, e.g.
String	getPrimaryTablePath()	Returns primary table path.
String	getSystem()	Returns the name descriptor of the system where the index is hosted, e.g.
boolean	isDisabled()	Returns true if the index is disabled.
boolean	isExternal()	Returns true if the index is not a native MapR-DB index.
boolean	isUnique()	Returns true if the values of the indexed field or the combination of fields in case of composite index, are unique across all documents in the table.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getIndexedFields

public List<ExtIndexFieldDesc> getIndexedFields()

Description copied from interface: ExtIndexDesc

Returns an ordered list of field descriptors which are indexed. For single field indexes, this list contains exactly one element while for composite indexes, it will contain one element for each field in the composite index, in the order they appear in the index.

Specified by:

getIndexedFields in interface ExtIndexDesc

getCoveredFields

public Collection<ExtIndexFieldDesc> getCoveredFields()

Description copied from interface: ExtIndexDesc

Returns a collection of covered fields that are stored in this Index but are not indexed.

Specified by:

getCoveredFields in interface ExtIndexDesc

isUnique

public boolean isUnique()

Description copied from interface: ExtIndexDesc

Returns true if the values of the indexed field or the combination of fields in case of composite index, are unique across all documents in the table.

Specified by:

isUnique in interface ExtIndexDesc

isExternal

public boolean isExternal()

Description copied from interface: ExtIndexDesc

Returns true if the index is not a native MapR-DB index.

Specified by:

isExternal in interface ExtIndexDesc

isDisabled

public boolean isDisabled()

Description copied from interface: ExtIndexDesc

Returns true if the index is disabled.

Specified by:

isDisabled in interface ExtIndexDesc

getPrimaryTablePath

public String getPrimaryTablePath()

Description copied from interface: ExtIndexDesc

Returns primary table path.

Specified by:

getPrimaryTablePath in interface ExtIndexDesc

getIndexFid

public String getIndexFid()

Description copied from interface: ExtIndexDesc

Returns secondary index table FID.

Specified by:

getIndexFid in interface ExtIndexDesc

getIndexName

public String getIndexName()

Description copied from interface: ExtIndexDesc

Returns the fully qualified, canonical name of the index, e.g. path of the native secondary index in MapR-DB. For external secondary indexes, the format will be dependent on the external system.

Specified by:

getIndexName in interface ExtIndexDesc

getSystem

public String getSystem()

Description copied from interface: ExtIndexDesc

Returns the name descriptor of the system where the index is hosted, e.g. "maprdb" for native secondary index.

Specified by:

getSystem in interface ExtIndexDesc

getCluster

public String getCluster()

Description copied from interface: ExtIndexDesc

Returns the cluster identifier of the system.

Specified by:

getCluster in interface ExtIndexDesc

getConnectionString

public String getConnectionString()

Description copied from interface: ExtIndexDesc

For the external system that supports it, returns the connection string, null for native secondary indexes.

Specified by:

getConnectionString in interface ExtIndexDesc

toString

public String toString()

Overrides:

toString in class Object