Interface CalculatedMeasure

All Superinterfaces:
CMetadata, Feature, LogicalColumn, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Measure, PrimaryType, Remote, Root

public interface CalculatedMeasure extends Measure
In a dimension, a member whose value is derived from the values of other members.

Attributes of CalculatedMeasure are:

Associations of CalculatedMeasure are:

Usage

To create an instance of this CalculatedMeasure, use the factory create methods.
Example: create a CalculatedMeasure with name "CalculatedMeasure_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();
 CalculatedMeasure myObject = (CalculatedMeasure) factory.createComplexMetadataObject(objectStore, "CalculatedMeasure_Object", MetadataObjects.CALCULATEDMEASURE, "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_EXPRESSION_NAME

      static final String ATTRIBUTE_EXPRESSION_NAME
      Constant used for the name of the Expression attribute.

      Expression: The formula.

      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 LogicalColumn
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface Measure
      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:
      Specified by:
      initializePredObjects in interface Feature
      Specified by:
      initializePredObjects in interface LogicalColumn
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface Measure
      Specified by:
      initializePredObjects in interface PrimaryType
      Specified by:
      initializePredObjects in interface Root
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
    • getExpression

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

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

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

      void setExpression(String inExpression) throws RemoteException
      Sets the Expression value and sets the state to MetadataState.LOCAL.
      Parameters:
      inExpression - String
      Throws:
      RemoteException - If error communicating with remote object.
    • setExpression

      void setExpression(String inExpression, int state) throws RemoteException
      Sets the Expression Metadata State.
      Parameters:
      inExpression - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.
    • setExpressionState

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