Package com.sas.metadata.remote

Interface PhysicalTable

All Superinterfaces:
Classifier, CMetadata, DataTable, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, RelationalTable, Remote, Root
All Known Subinterfaces:
SecuredTable, WorkTable
public interface PhysicalTable extends RelationalTable
A "materialized" table that resides in a database or a file system.

Attributes of PhysicalTable are:

Associations of PhysicalTable are:

Usage

To create an instance of this PhysicalTable, use the factory create methods.
Example: create a PhysicalTable with name "PhysicalTable_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();
 PhysicalTable myObject = (PhysicalTable) factory.createComplexMetadataObject(objectStore, "PhysicalTable_Object", MetadataObjects.PHYSICALTABLE, "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_ISCOMPRESSED_NAME

      static final String ATTRIBUTE_ISCOMPRESSED_NAME
      Constant used for the name of the IsCompressed attribute.

      IsCompressed: This attribute indicates whether this table is compressed or not.

      See Also:

    • ATTRIBUTE_ISENCRYPTED_NAME

      static final String ATTRIBUTE_ISENCRYPTED_NAME
      Constant used for the name of the IsEncrypted attribute.

      IsEncrypted: Is the table encrypted?

      See Also:

    • ATTRIBUTE_DBMSTYPE_NAME

      static final String ATTRIBUTE_DBMSTYPE_NAME
      Constant used for the name of the DBMSType attribute.

      DBMSType: If this table resides in a DBMS, this attribute describes the type of the DBMS. These types are the same as the SAS engine types.

      See Also:

    • ATTRIBUTE_SASTABLENAME_NAME

      static final String ATTRIBUTE_SASTABLENAME_NAME
      Constant used for the name of the SASTableName attribute.

      SASTableName: This is the name that SAS software uses to refer to the table. Typically the SAS name is 32 characters in length and conforms to the SAS naming restrictions, for example, no space or special characters.

      This attribute can support mixed case names, and special characters and spaces in the text, if there is a property set and one or two properties are configured on the table to indicate that this table requires special handling for its names.

      In order to support special characters and spaces, as well case-sensitive names in the text of this attribute, a PropertySet must be attached to the table. The PropertySet is named DBMSNames with a SetRole=DBMSNames. This set can contain two properties; Case and SpecChar. Case is used to indicate if the values in teh SASTableName/SASColumnName attribute are case-sensitive or not. SpecChar is used to indicate if the values in the SASTableName/SASColumnName can contain special characters including spaces.

      See Also:

    • ATTRIBUTE_ISDBMSVIEW_NAME

      static final String ATTRIBUTE_ISDBMSVIEW_NAME
      Constant used for the name of the IsDBMSView attribute.

      IsDBMSView: This attribute indicates that this physical table object represents a view in the DBMS.

      See Also:

    • ASSOCIATION_AGGREGATIONS_NAME

      static final String ASSOCIATION_AGGREGATIONS_NAME
      Constant used for the name of the Aggregations association.

      Aggregations: The aggregations associated with this table.  

      See Also:

    • ASSOCIATION_INDEXES_NAME

      static final String ASSOCIATION_INDEXES_NAME
      Constant used for the name of the Indexes association.

      Indexes: The list of indexes for this table.  

      See Also:

    • ASSOCIATION_SASPASSWORDS_NAME

      static final String ASSOCIATION_SASPASSWORDS_NAME
      Constant used for the name of the SASPasswords association.

      SASPasswords: The list of passwords used with this table.  

      See Also:

    • ASSOCIATION_TRAINEDMODELRESULTS_NAME

      static final String ASSOCIATION_TRAINEDMODELRESULTS_NAME
      Constant used for the name of the TrainedModelResults association.

      TrainedModelResults: The mining results associated with this training table.  

      See Also:

    • ASSOCIATION_REACHTHRUCUBES_NAME

      static final String ASSOCIATION_REACHTHRUCUBES_NAME
      Constant used for the name of the ReachThruCubes association.

      ReachThruCubes: The cubes that use this table for reachthru. 

      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 RelationalTable
      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:
      Aggregations
      Indexes
      SASPasswords
      TrainedModelResults
      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 RelationalTable
      Specified by:
      initializePredObjects in interface Root
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIsCompressed

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

    • getIsCompressedState

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

    • getIsEncrypted

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

    • getIsEncryptedState

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

    • getDBMSType

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

    • getDBMSTypeState

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

    • getDBMSTypeMaxLength

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

    • getSASTableName

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

    • getSASTableNameState

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

    • getSASTableNameMaxLength

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

    • getIsDBMSView

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

    • getIsDBMSViewState

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

    • getAggregations

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

    • getIndexes

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

    • getSASPasswords

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

    • getTrainedModelResults

      AssociationList getTrainedModelResults() throws RemoteException, MdException
      Gets the AssociationList of TrainedModelResults
      Returns:
      Returns the AssociationList of TrainedModelResults 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.

    • getReachThruCubes

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

    • getAggregations

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

    • getIndexes

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

    • getSASPasswords

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

    • getTrainedModelResults

      AssociationList getTrainedModelResults(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of TrainedModelResults
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of TrainedModelResults 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.

    • getReachThruCubes

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

    • setIsCompressed

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

    • setIsCompressed

      void setIsCompressed(int inIsCompressed, int state) throws RemoteException
      Sets the IsCompressed Metadata State.
      Parameters:
      inIsCompressed - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsCompressed

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

    • setIsCompressed

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

    • setIsCompressedState

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

    • setIsEncrypted

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

    • setIsEncrypted

      void setIsEncrypted(int inIsEncrypted, int state) throws RemoteException
      Sets the IsEncrypted Metadata State.
      Parameters:
      inIsEncrypted - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsEncrypted

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

    • setIsEncrypted

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

    • setIsEncryptedState

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

    • setDBMSType

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

    • setDBMSType

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

    • setDBMSTypeState

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

    • setSASTableName

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

    • setSASTableName

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

    • setSASTableNameState

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

    • setIsDBMSView

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

    • setIsDBMSView

      void setIsDBMSView(int inIsDBMSView, int state) throws RemoteException
      Sets the IsDBMSView Metadata State.
      Parameters:
      inIsDBMSView - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsDBMSView

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

    • setIsDBMSView

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

    • setIsDBMSViewState

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

    • setAggregations

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

    • setAggregations

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

    • setIndexes

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

    • setIndexes

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

    • setSASPasswords

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

    • setSASPasswords

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

    • setTrainedModelResults

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

    • setTrainedModelResults

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

    • setReachThruCubes

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

    • setReachThruCubes

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