Package com.sas.metadata.remote

Interface Level

All Superinterfaces:
CMetadata, Feature, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface Level extends Feature
An element of a dimension hierarchy. Levels describe the dimension from the highest (most summarized) level to the lowest (most detailed) level. For example, possible levels for a Geography dimension are Country, Region, State or Province, and City.

Attributes of Level are:

Associations of Level are:

Usage

To create an instance of this Level, use the factory create methods.
Example: create a Level with name "Level_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();
 Level myObject = (Level) factory.createComplexMetadataObject(objectStore, "Level_Object", MetadataObjects.LEVEL, "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_CARDINALITY_NAME

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

      Cardinality: The number of members in this level.

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

      See Also:

    • ATTRIBUTE_LEVELTYPE_NAME

      static final String ATTRIBUTE_LEVELTYPE_NAME
      Constant used for the name of the LevelType attribute.

      LevelType: An enumeration of types of levels. From the OLEDB for OLAP spec. REGULAR 1 TIME 8 YEARS 16 HALF_YEARS 32 QUARTERS 64 MONTHS 128 WEEKS 256 DAYS 512 HOURS 1024 MINUTES 2048 SECONDS 4096

      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:

    • 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 list of hierarchies that include this level.  

      See Also:

    • ASSOCIATION_OLAPPROPERTIES_NAME

      static final String ASSOCIATION_OLAPPROPERTIES_NAME
      Constant used for the name of the OLAPProperties association.

      OLAPProperties: The list of OLAP properties for this level.  

      See Also:

    • ASSOCIATION_OWNINGDIMENSION_NAME

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

      OwningDimension: The dimension that includes this level.  

      See Also:

    • ASSOCIATION_AGGREGATIONS_NAME

      static final String ASSOCIATION_AGGREGATIONS_NAME
      Constant used for the name of the Aggregations association.

      Aggregations: The aggregations associated with this level. 

      See Also:

    • ASSOCIATION_CALCULATEDMEMBERS_NAME

      static final String ASSOCIATION_CALCULATEDMEMBERS_NAME
      Constant used for the name of the CalculatedMembers association.

      CalculatedMembers: The calculated members for this level. 

      See Also:

    • ASSOCIATION_HIERARCHYLEVELS_NAME

      static final String ASSOCIATION_HIERARCHYLEVELS_NAME
      Constant used for the name of the HierarchyLevels association.

      HierarchyLevels: The list of hierarchy levels associated with this level. 

      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 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
      OLAPProperties
      OwningDimension
      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.

    • getCardinality

      int getCardinality() throws RemoteException
      Gets the int 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.

    • getLevelType

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

    • getLevelTypeState

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

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

    • getOLAPProperties

      AssociationList getOLAPProperties() throws RemoteException, MdException
      Gets the AssociationList of OLAPProperties
      Returns:
      Returns the AssociationList of OLAPProperties which can be of type:
      OLAPProperty
      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.

    • getAggregations

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

    • getCalculatedMembers

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

    • getHierarchyLevels

      AssociationList getHierarchyLevels() throws RemoteException, MdException
      Gets the Association list of HierarchyLevels
      Returns:
      The AssociationList of HierarchyLevels which can be of type:
      HierarchyLevel
      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.

    • getOLAPProperties

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

    • getAggregations

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

    • getCalculatedMembers

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

    • getHierarchyLevels

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

    • setCardinality

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

    • setCardinality

      void setCardinality(int inCardinality, int state) throws RemoteException
      Sets the Cardinality Metadata State.
      Parameters:
      inCardinality - int
      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.

    • setLevelType

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

    • setLevelType

      void setLevelType(int inLevelType, int state) throws RemoteException
      Sets the LevelType Metadata State.
      Parameters:
      inLevelType - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setLevelType

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

    • setLevelType

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

    • setLevelTypeState

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

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

    • setOLAPProperties

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

    • setOLAPProperties

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

    • setAggregations

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

    • setAggregations

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

    • setCalculatedMembers

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

    • setCalculatedMembers

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

    • setHierarchyLevels

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

    • setHierarchyLevels

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