Package com.sas.metadata.remote

Interface CalculatedMember

All Superinterfaces:
CMetadata, Feature, GlobalFormula, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface CalculatedMember extends GlobalFormula
Beginning in SAS 9.3, represents a new member in a dimension of a cube. A CalculatedMember object is required to have an association to a Hierarchy object and supports an optional association to a Level object in addition to having an association to the owning Cube object. If the associated Hierarchy object is deleted, the CalculatedMember is deleted as well.

Attributes of CalculatedMember are:

Associations of CalculatedMember are:

Usage

To create an instance of this CalculatedMember, use the factory create methods.
Example: create a CalculatedMember with name "CalculatedMember_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();
 CalculatedMember myObject = (CalculatedMember) factory.createComplexMetadataObject(objectStore, "CalculatedMember_Object", MetadataObjects.CALCULATEDMEMBER, "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_ASSOCIATEDLEVEL_NAME

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

      AssociatedLevel: The level associated with this calculated member.  

      See Also:

    • ASSOCIATION_OWNINGHIERARCHY_NAME

      static final String ASSOCIATION_OWNINGHIERARCHY_NAME
      Constant used for the name of the OwningHierarchy association.

      OwningHierarchy: The hierarchy associated with this calculated member.  

      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 GlobalFormula
      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:
      AssociatedLevel
      OwningHierarchy
      Specified by:
      initializePredObjects in interface Feature
      Specified by:
      initializePredObjects in interface GlobalFormula
      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.

    • getAssociatedLevels

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

    • getAssociatedLevel

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

    • getOwningHierarchys

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

    • getOwningHierarchy

      Hierarchy getOwningHierarchy() throws RemoteException, MdException
      Gets the Hierarchy for OwningHierarchy
      Returns:
      The Hierarchy ( null if not set) of OwningHierarchywhich 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 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.

    • getOwningHierarchys

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

    • setAssociatedLevels

      void setAssociatedLevels(AssociationList list) throws RemoteException
      Sets the AssociatedLevels list to be list. Object 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. Object 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.

    • setOwningHierarchys

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

    • setOwningHierarchys

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

    • setOwningHierarchy

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