Package com.sas.metadata.remote

Interface Dimension

All Superinterfaces:
Classifier, CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
All Known Subinterfaces:
SharedDimension
public interface Dimension extends Classifier
A group of closely related hierarchies. Hierarchies within a dimension typically represent different groupings of information that pertains to a single concept. For example, a Time dimension might consist of two hierarchies: (1) Year, Month, Date, and (2) Year, Week, Day. See also hierarchy.

Attributes of Dimension are:

Associations of Dimension are:

Usage

To create an instance of this Dimension, use the factory create methods.
Example: create a Dimension with name "Dimension_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();
 Dimension myObject = (Dimension) factory.createComplexMetadataObject(objectStore, "Dimension_Object", MetadataObjects.DIMENSION, "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_DIMENSIONTYPE_NAME

      static final String ATTRIBUTE_DIMENSIONTYPE_NAME
      Constant used for the name of the DimensionType attribute.

      DimensionType: The type of this dimension: STANDARD, MEASURES or TIME.

      See Also:

    • ATTRIBUTE_CARDINALITY_NAME

      static final String ATTRIBUTE_CARDINALITY_NAME
      Constant used for the name of the Cardinality attribute.

      Cardinality: The number of unique values for the dimension.

      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 this dimension.

      See Also:

    • ATTRIBUTE_SORTORDER_NAME

      static final String ATTRIBUTE_SORTORDER_NAME
      Constant used for the name of the SortOrder attribute.

      SortOrder: This is an indication of the sort order of this column in this table. It can be ASCENDING, DESCENDING, ASCFORMATTED, DESFORMATTED, DSORDER.

      See Also:

    • ASSOCIATION_ASSOCIATEDOLAPSCHEMA_NAME

      static final String ASSOCIATION_ASSOCIATEDOLAPSCHEMA_NAME
      Constant used for the name of the AssociatedOLAPSchema association.

      AssociatedOLAPSchema: The OLAP schema that contains this dimension.  

      See Also:

    • ASSOCIATION_CUBES_NAME

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

      Cubes: The list of cubes that include this dimension. 

      See Also:

    • ASSOCIATION_HIERARCHIES_NAME

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

      Hierarchies: The list of hierarchies for this dimension. 

      See Also:

    • ASSOCIATION_LEVELS_NAME

      static final String ASSOCIATION_LEVELS_NAME
      Constant used for the name of the Levels association.

      Levels: The list of levels for this dimension. 

      See Also:

    • ASSOCIATION_MEASURES_NAME

      static final String ASSOCIATION_MEASURES_NAME
      Constant used for the name of the Measures association.

      Measures: *Unknown* 

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getDimensionType

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

    • getDimensionTypeState

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

    • getDimensionTypeMaxLength

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

    • getCardinality

      double getCardinality() throws RemoteException
      Gets the double value of Cardinality
      Returns:
      The Cardinality
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getCardinalityState

      int getCardinalityState() throws RemoteException
      Gets the Metadata State of Cardinality
      Returns:
      The State.
      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.

    • getSortOrder

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

    • getSortOrderState

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

    • getSortOrderMaxLength

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

    • getAssociatedOLAPSchemas

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

    • getAssociatedOLAPSchema

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

    • getCubes

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

    • getHierarchies

      AssociationList getHierarchies() throws RemoteException, MdException
      Gets the Association list of Hierarchies
      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.

    • getLevels

      AssociationList getLevels() throws RemoteException, MdException
      Gets the Association list of Levels
      Returns:
      The AssociationList of Levels 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.

    • getMeasures

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

    • getAssociatedOLAPSchemas

      AssociationList getAssociatedOLAPSchemas(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of AssociatedOLAPSchemas
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of AssociatedOLAPSchemas which can be of type:
      OLAPSchema
      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 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.

    • 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 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.

    • getLevels

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

    • getMeasures

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

    • setDimensionType

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

    • setDimensionType

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

    • setDimensionTypeState

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

    • setCardinality

      void setCardinality(double inCardinality) throws RemoteException
      Sets the Cardinality value and sets the state to MetadataState.LOCAL.
      Parameters:
      inCardinality - double
      Throws:
      RemoteException - If error communicating with remote object.

    • setCardinality

      void setCardinality(double inCardinality, int state) throws RemoteException
      Sets the Cardinality Metadata State.
      Parameters:
      inCardinality - double
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setCardinality

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

    • setCardinality

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

    • setCardinalityState

      void setCardinalityState(int state) throws RemoteException
      Sets the Metadata State of Cardinality.
      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.

    • setSortOrder

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

    • setSortOrder

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

    • setSortOrderState

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

    • setAssociatedOLAPSchemas

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

    • setAssociatedOLAPSchemas

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

    • setAssociatedOLAPSchema

      void setAssociatedOLAPSchema(OLAPSchema inObject) throws RemoteException
      Sets the AssociatedOLAPSchemas list 0th element to be inObject.
      Parameters:
      inObject - OLAPSchema
      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 Cubes list to match the passed in AssociationList, sets the state of the Cubes
      Parameters:
      inObjects - AssociationList
      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 Hierarchies list to match the passed in AssociationList, sets the state of the Hierarchies
      Parameters:
      inObjects - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setLevels

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

    • setLevels

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

    • setMeasures

      void setMeasures(AssociationList list) throws RemoteException
      Sets the Measures list to be list. Objects of which can be of type:
      Measure
      CalculatedMeasure
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setMeasures

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