Package com.sas.metadata.remote

Interface Measure

All Superinterfaces:
CMetadata, Feature, LogicalColumn, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
All Known Subinterfaces:
CalculatedMeasure
public interface Measure extends LogicalColumn
A special dimension that contains summarized numeric data values that are analyzed. Total Sales and Average Revenue are examples of measures. For example, you might drill down within the Clothing hierarchy of the Product dimension to see the value of the Total Sales measure for the Shirts member.

Attributes of Measure are:

Associations of Measure are:

Usage

To create an instance of this Measure, use the factory create methods.
Example: create a Measure with name "Measure_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();
 Measure myObject = (Measure) factory.createComplexMetadataObject(objectStore, "Measure_Object", MetadataObjects.MEASURE, "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_ISSTOREDSTATISTIC_NAME

      static final String ATTRIBUTE_ISSTOREDSTATISTIC_NAME
      Constant used for the name of the IsStoredStatistic attribute.

      IsStoredStatistic: True if the statistic is precalculated, false if the statistic need to be calculated.

      See Also:

    • ATTRIBUTE_STATISTIC_NAME

      static final String ATTRIBUTE_STATISTIC_NAME
      Constant used for the name of the Statistic attribute.

      Statistic: Later we will add a list of recommended string values.

      See Also:

    • ATTRIBUTE_UNIQUENAME_NAME

      static final String ATTRIBUTE_UNIQUENAME_NAME
      Constant used for the name of the UniqueName attribute.

      UniqueName: The unique name for a measure

      See Also:

    • ATTRIBUTE_UNITS_NAME

      static final String ATTRIBUTE_UNITS_NAME
      Constant used for the name of the Units attribute.

      Units: The units of the measure.

      See Also:

    • ASSOCIATION_CUBES_NAME

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

      Cubes: The cubes that contain this measure.  

      See Also:

    • ASSOCIATION_OWNINGDIMENSION_NAME

      static final String ASSOCIATION_OWNINGDIMENSION_NAME
      Constant used for the name of the OwningDimension association.

      OwningDimension: The dimension that contains this measure.  

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getIsStoredStatistic

      int getIsStoredStatistic() throws RemoteException
      Gets the int value of IsStoredStatistic
      Returns:
      The IsStoredStatistic
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIsStoredStatisticState

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

    • getStatistic

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

    • getStatisticState

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

    • getStatisticMaxLength

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

    • getUniqueName

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

    • getUniqueNameState

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

    • getUniqueNameMaxLength

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

    • getUnits

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

    • getUnitsState

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

    • getUnitsMaxLength

      int getUnitsMaxLength() throws RemoteException
      Gets the maximum length of Units
      Returns:
      The max size
      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.

    • getOwningDimensions

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

    • getOwningDimension

      Dimension getOwningDimension() throws RemoteException, MdException
      Gets the Dimension for OwningDimension
      Returns:
      The Dimension ( null if not set) of OwningDimensionwhich 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.

    • getOwningDimensions

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

    • setIsStoredStatistic

      void setIsStoredStatistic(int inIsStoredStatistic) throws RemoteException
      Sets the IsStoredStatistic value and sets the state to MetadataState.LOCAL.
      Parameters:
      inIsStoredStatistic - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsStoredStatistic

      void setIsStoredStatistic(int inIsStoredStatistic, int state) throws RemoteException
      Sets the IsStoredStatistic Metadata State.
      Parameters:
      inIsStoredStatistic - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsStoredStatistic

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

    • setIsStoredStatistic

      void setIsStoredStatistic(String inIsStoredStatistic, int state) throws RemoteException
      Sets the IsStoredStatistic value and Metadata State.
      Parameters:
      inIsStoredStatistic - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsStoredStatisticState

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

    • setStatistic

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

    • setStatistic

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

    • setStatisticState

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

    • setUniqueName

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

    • setUniqueName

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

    • setUniqueNameState

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

    • setUnits

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

    • setUnits

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

    • setUnitsState

      void setUnitsState(int state) throws RemoteException
      Sets the Metadata State of Units.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote 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.

    • setOwningDimensions

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

    • setOwningDimensions

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

    • setOwningDimension

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