Package com.sas.metadata.remote

Interface RelationalTable

All Superinterfaces:
Classifier, CMetadata, DataTable, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
All Known Subinterfaces:
JoinTable, PhysicalTable, QueryTable, SecuredTable, WorkTable
public interface RelationalTable extends DataTable
Represents a relational table, one that does not have a physical representation. If the table resides in a DBMS or file system, it should be represented by a PhysicalTable. If it is a transient table, one that has a physical representation but is temporary, it should be represented as a WorkTable.

Attributes of RelationalTable are:

Associations of RelationalTable are:

Usage

To create an instance of this RelationalTable, use the factory create methods.
Example: create a RelationalTable with name "RelationalTable_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();
 RelationalTable myObject = (RelationalTable) factory.createComplexMetadataObject(objectStore, "RelationalTable_Object", MetadataObjects.RELATIONALTABLE, "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_MEMBERTYPE_NAME

      static final String ATTRIBUTE_MEMBERTYPE_NAME
      Constant used for the name of the MemberType attribute.

      MemberType: The MemberType attribute is the value of memtype returned by proc contents output. It can have the values of DATA, VIEW, MDDB, etc.

      See Also:

    • ASSOCIATION_XPATHS_NAME

      static final String ASSOCIATION_XPATHS_NAME
      Constant used for the name of the XPaths association.

      XPaths: The list of XPath objects that define the path of the table in the XML source.  

      See Also:

    • ASSOCIATION_ANALYTICTABLES_NAME

      static final String ASSOCIATION_ANALYTICTABLES_NAME
      Constant used for the name of the AnalyticTables association.

      AnalyticTables: The analytic table attributes associated with this table. 

      See Also:

    • ASSOCIATION_ASSOCIATEDXMLMAP_NAME

      static final String ASSOCIATION_ASSOCIATEDXMLMAP_NAME
      Constant used for the name of the AssociatedXMLMap association.

      AssociatedXMLMap: The associated XML Map. 

      See Also:

    • ASSOCIATION_MODELRESULTS_NAME

      static final String ASSOCIATION_MODELRESULTS_NAME
      Constant used for the name of the ModelResults association.

      ModelResults: The mining results associated to this target table. 

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface Classifier
      Specified by:
      initializeRequiredObjects in interface DataTable
      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:
      XPaths
      Specified by:
      initializePredObjects in interface Classifier
      Specified by:
      initializePredObjects in interface DataTable
      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.

    • getMemberType

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

    • getMemberTypeState

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

    • getMemberTypeMaxLength

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

    • getXPaths

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

    • getAnalyticTables

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

    • getAssociatedXMLMaps

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

    • getAssociatedXMLMap

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

    • getModelResults

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

    • getXPaths

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

    • getAnalyticTables

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

    • getAssociatedXMLMaps

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

    • getModelResults

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

    • setMemberType

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

    • setMemberType

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

    • setMemberTypeState

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

    • setXPaths

      void setXPaths(AssociationList list) throws RemoteException
      Sets the XPaths list to be list. Objects of which can be of type:
      XPath
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setXPaths

      void setXPaths(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.

    • setAnalyticTables

      void setAnalyticTables(AssociationList list) throws RemoteException
      Sets the AnalyticTables list to be list. Objects of which can be of type:
      AnalyticTable
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setAnalyticTables

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

    • setAssociatedXMLMaps

      void setAssociatedXMLMaps(AssociationList list) throws RemoteException
      Sets the AssociatedXMLMaps list to be list. Objects of which can be of type:
      SXLEMap
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedXMLMaps

      void setAssociatedXMLMaps(AssociationList list, int state) throws RemoteException
      Sets the AssociatedXMLMaps list to be list. Objects of which can be of type:
      SXLEMap
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedXMLMap

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

    • setModelResults

      void setModelResults(AssociationList list) throws RemoteException
      Sets the ModelResults list to be list. Objects of which can be of type:
      MiningResult
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setModelResults

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