Package com.sas.metadata.remote

Interface Index

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface Index extends PrimaryType
Represents an index on a physical structure. It is tied to the columns that make up the index.

Attributes of Index are:

Associations of Index are:

Usage

To create an instance of this Index, use the factory create methods.
Example: create a Index with name "Index_Object", in repository "AAAAAAAA".
 // create a store to contain your objects for this change. If you do not have an existing object
 // or store to use.  You may obtain the store from another object by using Object.getObjectStore().
 MdFactory factory; //where "factory" is a valid MdFactory instance
 MdObjectStore objectStore = factory.createObjectStore();
 Index myObject = (Index) factory.createComplexMetadataObject(objectStore, "Index_Object", MetadataObjects.INDEX, "AAAAAAAA");
 myObject.updateMetadataAll();  // Write object to server
 objectStore.dispose();  // dispose of the object store if it is no longer needed

Behavior

  • Attributes and associations for this object can be retrieved by using the methods in MdOMIUtil.
  • When changes are made to the object, either by setting an attribute or adding objects to a particular association, they can be persisted to the metadata server with the updateMetadataAll method.
  • If an object needs to be deleted, the delete method can be used. This will flag the object as being deleted on the client, and will require an update call to persist the change to the server.

Dependencies

This class depends on objects being contained in an MdObjectStore. Object stores should be disposed of when they are no longer needed as this will help clean up memory. Disposing an object store will dispose of all objects contained within that store.

Since:
9.0

  • Field Details

    • ATTRIBUTE_ISCLUSTERED_NAME

      static final String ATTRIBUTE_ISCLUSTERED_NAME
      Constant used for the name of the IsClustered attribute.

      IsClustered: This attribute indicates that this index supports clustering.

      See Also:

    • ATTRIBUTE_ISUNIQUE_NAME

      static final String ATTRIBUTE_ISUNIQUE_NAME
      Constant used for the name of the IsUnique attribute.

      IsUnique: This attribute indicates whether this index is a unique index or not.

      See Also:

    • ATTRIBUTE_INDEXNAME_NAME

      static final String ATTRIBUTE_INDEXNAME_NAME
      Constant used for the name of the IndexName attribute.

      IndexName: The name of the index.

      See Also:

    • ATTRIBUTE_ISNOMISS_NAME

      static final String ATTRIBUTE_ISNOMISS_NAME
      Constant used for the name of the IsNoMiss attribute.

      IsNoMiss: If true, then missing values are not maintained by the index

      See Also:

    • ASSOCIATION_COLUMNS_NAME

      static final String ASSOCIATION_COLUMNS_NAME
      Constant used for the name of the Columns association.

      Columns: The list of columns that are indexed by this index.  

      See Also:

    • ASSOCIATION_OWNINGPHYSICALTABLE_NAME

      static final String ASSOCIATION_OWNINGPHYSICALTABLE_NAME
      Constant used for the name of the OwningPhysicalTable association.

      OwningPhysicalTable: The table that is indexed by this object. 

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      OwningPhysicalTable
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface PrimaryType
      Specified by:
      initializeRequiredObjects in interface Root
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • initializePredObjects

      void initializePredObjects() throws RemoteException
      (S) Adds the Associated objects to the predObjects which are:
      Columns
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface PrimaryType
      Specified by:
      initializePredObjects in interface Root
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIsClustered

      int getIsClustered() throws RemoteException
      Gets the int value of IsClustered
      Returns:
      The IsClustered
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIsClusteredState

      int getIsClusteredState() throws RemoteException
      Gets the Metadata State of IsClustered
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIsUnique

      int getIsUnique() throws RemoteException
      Gets the int value of IsUnique
      Returns:
      The IsUnique
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIsUniqueState

      int getIsUniqueState() throws RemoteException
      Gets the Metadata State of IsUnique
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIndexName

      String getIndexName() throws RemoteException
      Gets the String value of IndexName
      Returns:
      The IndexName
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIndexNameState

      int getIndexNameState() throws RemoteException
      Gets the Metadata State of IndexName
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIndexNameMaxLength

      int getIndexNameMaxLength() throws RemoteException
      Gets the maximum length of IndexName
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIsNoMiss

      int getIsNoMiss() throws RemoteException
      Gets the int value of IsNoMiss
      Returns:
      The IsNoMiss
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIsNoMissState

      int getIsNoMissState() throws RemoteException
      Gets the Metadata State of IsNoMiss
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getColumns

      AssociationList getColumns() throws RemoteException, MdException
      Gets the AssociationList of Columns
      Returns:
      Returns the AssociationList of Columns which can be of type:
      Column
      ColumnRange
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getOwningPhysicalTables

      AssociationList getOwningPhysicalTables() throws RemoteException, MdException
      Gets the Association list of OwningPhysicalTables
      Returns:
      The AssociationList of OwningPhysicalTables which can be of type:
      PhysicalTable
      WorkTable
      SecuredTable
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getOwningPhysicalTable

      PhysicalTable getOwningPhysicalTable() throws RemoteException, MdException
      Gets the PhysicalTable for OwningPhysicalTable
      Returns:
      The PhysicalTable ( null if not set ) of OwningPhysicalTable which can be of type:
      PhysicalTable
      WorkTable
      SecuredTable
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getColumns

      AssociationList getColumns(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of Columns
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of Columns which can be of type:
      Column
      ColumnRange
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getOwningPhysicalTables

      AssociationList getOwningPhysicalTables(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of OwningPhysicalTables
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the OwningPhysicalTables which can be of type:
      PhysicalTable
      WorkTable
      SecuredTable
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setIsClustered

      void setIsClustered(int inIsClustered) throws RemoteException
      Sets the IsClustered value and sets the state to MetadataState.LOCAL.
      Parameters:
      inIsClustered - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsClustered

      void setIsClustered(int inIsClustered, int state) throws RemoteException
      Sets the IsClustered Metadata State.
      Parameters:
      inIsClustered - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsClustered

      void setIsClustered(String inIsClustered) throws RemoteException
      Sets the IsClustered value and sets the state to MetadataState.LOCAL.
      Parameters:
      inIsClustered - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsClustered

      void setIsClustered(String inIsClustered, int state) throws RemoteException
      Sets the IsClustered value and Metadata State.
      Parameters:
      inIsClustered - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsClusteredState

      void setIsClusteredState(int state) throws RemoteException
      Sets the Metadata State of IsClustered.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsUnique

      void setIsUnique(int inIsUnique) throws RemoteException
      Sets the IsUnique value and sets the state to MetadataState.LOCAL.
      Parameters:
      inIsUnique - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsUnique

      void setIsUnique(int inIsUnique, int state) throws RemoteException
      Sets the IsUnique Metadata State.
      Parameters:
      inIsUnique - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsUnique

      void setIsUnique(String inIsUnique) throws RemoteException
      Sets the IsUnique value and sets the state to MetadataState.LOCAL.
      Parameters:
      inIsUnique - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsUnique

      void setIsUnique(String inIsUnique, int state) throws RemoteException
      Sets the IsUnique value and Metadata State.
      Parameters:
      inIsUnique - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsUniqueState

      void setIsUniqueState(int state) throws RemoteException
      Sets the Metadata State of IsUnique.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIndexName

      void setIndexName(String inIndexName) throws RemoteException
      Sets the IndexName value and sets the state to MetadataState.LOCAL.
      Parameters:
      inIndexName - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setIndexName

      void setIndexName(String inIndexName, int state) throws RemoteException
      Sets the IndexName Metadata State.
      Parameters:
      inIndexName - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIndexNameState

      void setIndexNameState(int state) throws RemoteException
      Sets the Metadata State of IndexName.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsNoMiss

      void setIsNoMiss(int inIsNoMiss) throws RemoteException
      Sets the IsNoMiss value and sets the state to MetadataState.LOCAL.
      Parameters:
      inIsNoMiss - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsNoMiss

      void setIsNoMiss(int inIsNoMiss, int state) throws RemoteException
      Sets the IsNoMiss Metadata State.
      Parameters:
      inIsNoMiss - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsNoMiss

      void setIsNoMiss(String inIsNoMiss) throws RemoteException
      Sets the IsNoMiss value and sets the state to MetadataState.LOCAL.
      Parameters:
      inIsNoMiss - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsNoMiss

      void setIsNoMiss(String inIsNoMiss, int state) throws RemoteException
      Sets the IsNoMiss value and Metadata State.
      Parameters:
      inIsNoMiss - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsNoMissState

      void setIsNoMissState(int state) throws RemoteException
      Sets the Metadata State of IsNoMiss.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setColumns

      void setColumns(AssociationList list) throws RemoteException
      Sets the Columns list to be list. Objects of which can be of type:
      Column
      ColumnRange
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setColumns

      void setColumns(AssociationList inObjects, int state) throws RemoteException
      Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList
      Parameters:
      inObjects - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setOwningPhysicalTables

      void setOwningPhysicalTables(AssociationList list) throws RemoteException
      Sets the OwningPhysicalTables list to be list. Objects of which can be of type:
      PhysicalTable
      WorkTable
      SecuredTable
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setOwningPhysicalTables

      void setOwningPhysicalTables(AssociationList list, int state) throws RemoteException
      Sets the OwningPhysicalTables list to be list. Objects of which can be of type:
      PhysicalTable
      WorkTable
      SecuredTable
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setOwningPhysicalTable

      void setOwningPhysicalTable(PhysicalTable inObject) throws RemoteException
      Sets the OwningPhysicalTables list 0th element to be inObject.
      Parameters:
      inObject - PhysicalTable
      Throws:
      RemoteException - If error communicating with remote object.