Package com.mapr.fs.tables.impl

Class ExtIndexDescImpl

  • All Implemented Interfaces:
    ExtIndexDesc
    public final class ExtIndexDescImpl
extends java.lang.Object
implements ExtIndexDesc

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCluster()
      Returns the cluster identifier of the system.
      java.lang.String getConnectionString()
      For the external system that supports it, returns the connection string, null for native secondary indexes.
      java.util.Collection<ExtIndexFieldDesc> getCoveredFields()
      Returns a collection of covered fields that are stored in this Index but are not indexed.
      java.util.List<ExtIndexFieldDesc> getIndexedFields()
      Returns an ordered list of field descriptors which are indexed.
      java.lang.String getIndexFid()
      Returns secondary index table FID.
      java.lang.String getIndexName()
      Returns the fully qualified, canonical name of the index, e.g.
      java.lang.String getPrimaryTablePath()
      Returns primary table path.
      java.lang.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.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getIndexedFields

        public java.util.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

      • 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

      • getIndexFid

        public java.lang.String getIndexFid()
        Description copied from interface: ExtIndexDesc
        Returns secondary index table FID.
        Specified by:
        getIndexFid in interface ExtIndexDesc

      • getIndexName

        public java.lang.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 java.lang.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 java.lang.String getCluster()
        Description copied from interface: ExtIndexDesc
        Returns the cluster identifier of the system.
        Specified by:
        getCluster in interface ExtIndexDesc

      • getConnectionString

        public java.lang.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 java.lang.String toString()
        Overrides:
        toString in class java.lang.Object