Package com.sas.metadata.remote

Interface OLAPSchema

All Superinterfaces:
CMetadata, DeployedDataPackage, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface OLAPSchema extends DeployedDataPackage
This is a grouping of Cubes accessible from a SAS OLAP server.

Attributes of OLAPSchema are:

Associations of OLAPSchema are:

Usage

To create an instance of this OLAPSchema, use the factory create methods.
Example: create a OLAPSchema with name "OLAPSchema_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();
 OLAPSchema myObject = (OLAPSchema) factory.createComplexMetadataObject(objectStore, "OLAPSchema_Object", MetadataObjects.OLAPSCHEMA, "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_CUBES_NAME

      static final String ASSOCIATION_CUBES_NAME
      Constant used for the name of the Cubes association.

      Cubes: The cubes that are accessible through this schema.  

      See Also:

    • ASSOCIATION_LOGFILE_NAME

      static final String ASSOCIATION_LOGFILE_NAME
      Constant used for the name of the LogFile association.

      LogFile: The log file for this schema.  

      See Also:

    • ASSOCIATION_DIMENSIONS_NAME

      static final String ASSOCIATION_DIMENSIONS_NAME
      Constant used for the name of the Dimensions association.

      Dimensions: Dimensions that are contained in this schema. 

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getCubes

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

    • getLogFiles

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

    • getLogFile

      File getLogFile() throws RemoteException, MdException
      Gets the File for LogFile
      Returns:
      The File ( null if not set) of LogFilewhich 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.

    • getDimensions

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

    • getCubes

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

    • getLogFiles

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

    • getDimensions

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

    • setCubes

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

    • setCubes

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

    • setLogFiles

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

    • setLogFiles

      void setLogFiles(AssociationList list, int state) throws RemoteException
      Sets the LogFiles 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.

    • setLogFile

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

    • setDimensions

      void setDimensions(AssociationList list) throws RemoteException
      Sets the Dimensions list to be list. Objects of which can be of type:
      Dimension
      SharedDimension
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setDimensions

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