Package com.sas.metadata.remote

Interface ExternalTable

All Superinterfaces:
Classifier, CMetadata, DataTable, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface ExternalTable extends DataTable
Represents a table in an external data file.

Attributes of ExternalTable are:

Associations of ExternalTable are:

Usage

To create an instance of this ExternalTable, use the factory create methods.
Example: create a ExternalTable with name "ExternalTable_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();
 ExternalTable myObject = (ExternalTable) factory.createComplexMetadataObject(objectStore, "ExternalTable_Object", MetadataObjects.EXTERNALTABLE, "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

    • ASSOCIATION_OWNINGFILE_NAME

      static final String ASSOCIATION_OWNINGFILE_NAME
      Constant used for the name of the OwningFile association.

      OwningFile: The file that contains the data for an external table.This relationship should not be used to represent SAS datasets. The PhysicalTable object should be used to represent a dataset.  

      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:
      OwningFile
      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.

    • getOwningFiles

      AssociationList getOwningFiles() throws RemoteException, MdException
      Gets the AssociationList of OwningFiles
      Returns:
      Returns the AssociationList of OwningFiles which can be of type:
      File
      ArchiveFile
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException

    • getOwningFile

      File getOwningFile() throws RemoteException, MdException
      Gets the File for OwningFile
      Returns:
      The File ( null if not set) of OwningFilewhich can be of type:
      File
      ArchiveFile
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getOwningFiles

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

    • setOwningFiles

      void setOwningFiles(AssociationList list) throws RemoteException
      Sets the OwningFiles list to be list. Object of which can be of type:
      File
      ArchiveFile
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setOwningFiles

      void setOwningFiles(AssociationList list, int state) throws RemoteException
      Sets the OwningFiles list to be list. Object of which can be of type:
      File
      ArchiveFile
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setOwningFile

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