Package com.sas.metadata.remote

Interface OLAPProperty

All Superinterfaces:
CMetadata, Feature, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface OLAPProperty extends Feature
An attribute associated with members of a given dimension level. It is a feature of a Dimension, and can associated with a Level, and to a Column through a FeatureMap.

Attributes of OLAPProperty are:

Associations of OLAPProperty are:

Usage

To create an instance of this OLAPProperty, use the factory create methods.
Example: create a OLAPProperty with name "OLAPProperty_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();
 OLAPProperty myObject = (OLAPProperty) factory.createComplexMetadataObject(objectStore, "OLAPProperty_Object", MetadataObjects.OLAPPROPERTY, "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_SASFORMAT_NAME

      static final String ATTRIBUTE_SASFORMAT_NAME
      Constant used for the name of the SASFormat attribute.

      SASFormat: SASFormat

      See Also:

    • ASSOCIATION_HIERARCHIES_NAME

      static final String ASSOCIATION_HIERARCHIES_NAME
      Constant used for the name of the Hierarchies association.

      Hierarchies: The hierarchies associated to this OLAP property.  

      See Also:

    • ASSOCIATION_ASSOCIATEDLEVEL_NAME

      static final String ASSOCIATION_ASSOCIATEDLEVEL_NAME
      Constant used for the name of the AssociatedLevel association.

      AssociatedLevel: The level associated to this OLAP property. 

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getSASFormat

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

    • getSASFormatState

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

    • getSASFormatMaxLength

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

    • getHierarchies

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

    • getAssociatedLevels

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

    • getAssociatedLevel

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

    • getHierarchies

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

    • getAssociatedLevels

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

    • setSASFormat

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

    • setSASFormat

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

    • setSASFormatState

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

    • setHierarchies

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

    • setHierarchies

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

    • setAssociatedLevels

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

    • setAssociatedLevels

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

    • setAssociatedLevel

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