Skip navigation links

Oracle® OLAP Java API Reference
11g Release 2 (11.2)

E10794-05


oracle.olapi.metadata.mdm
Class MdmStandardDimension

java.lang.Object
  extended by oracle.olapi.metadata.BaseMetadataObject
      extended by oracle.olapi.metadata.mdm.MdmObject
          extended by oracle.olapi.metadata.mdm.MdmSource
              extended by oracle.olapi.metadata.mdm.MdmDimension
                  extended by oracle.olapi.metadata.mdm.MdmPrimaryDimension
                      extended by oracle.olapi.metadata.mdm.MdmStandardDimension

All Implemented Interfaces:
MdmMemberListMapOwner, MdmQuery, MdmViewColumnOwner, MetadataObject, Buildable

public final class MdmStandardDimension
extends MdmPrimaryDimension

An MdmPrimaryDimension that represents most types of metadata for Oracle OLAP dimensions, such as dimensions for products, customers, distribution channels, and so on. An application creates an MdmStandardDimension by calling the findOrCreateStandardDimension method of an MdmDatabaseSchema.


Method Summary
 java.lang.Object acceptVisitor(MdmObjectVisitor visitor, java.lang.Object context)
          Calls the visitMdmStandardDimension method of the MdmObjectVisitor and passes that method the MdmStandardDimension and an Object.
 void addCustomMember(MdmStandardMember customMember)
          Adds a custom member to the MdmStandardDimension.
 MdmStandardMember createCustomMember(java.lang.String name, MdmLevel level, java.lang.String parent, MdmLevel parentLevel, Source source, int precedence)
          Creates a custom dimension member with the specified parent level for the MdmStandardDimension.
 MdmStandardMember createCustomMember(java.lang.String name, MdmLevel level, java.lang.String parent, Source source, int precedence)
          Creates a custom dimension member for the MdmStandardDimension.
 MdmStandardMember createCustomMember(java.lang.String name, MdmValueHierarchy valueHier, Source source, int precedence)
          Creates a custom dimension member for an MdmValueHierarchy component of the MdmStandardDimension.
 java.util.List getCustomMembers()
          Gets the custom members of the MdmStandardDimension.
 void removeCustomMember(MdmStandardMember customMember)
          Removes a custom member from the MdmStandardDimension.

 

Methods inherited from class oracle.olapi.metadata.mdm.MdmPrimaryDimension
addDimensionLevel, addHierarchy, addModel, findOrCreateAWPrimaryDimensionOrganization, findOrCreateBaseAttribute, findOrCreateDerivedAttribute, findOrCreateDimCalcModel, findOrCreateDimensionLevel, findOrCreateLevelHierarchy, findOrCreateMdmCustomMember, findOrCreateMemberListMap, findOrCreateMultiValuedDerivedAttribute, findOrCreateRolapPrimaryDimensionOrganization, findOrCreateValueHierarchy, getAncestorsAttribute, getAttributes, getDefaultCalcModel, getDefaultHierarchy, getDimensionLevels, getETDimensionOrderColumn, getETHierarchyOrderColumn, getETKeyColumn, getETLevelNameColumn, getETLocalValueColumn, getETMemberTypeColumn, getETViewName, getHierarchies, getHierarchy, getHierarchyAttribute, getIsCustomMemberAttribute, getLevelAttribute, getLevelDepthAttribute, getLocalValueAttribute, getMdmCustomMembers, getMemberListMap, getModels, getNamespace, getOrganization, getOwner, getParentAttribute, getPersistentLanguages, getQuery, getQueryColumn, getQueryColumns, getQueryName, getShortValueDescriptionAttribute, getType, getValueDescriptionAttribute, getValueLineageAttribute, getValueSeparationString, removeAttribute, removeDimensionLevel, removeHierarchy, removeMdmCustomMember, removeModel, setDefaultCalcModel, setDefaultHierarchy, setETViewName, setMemberListMap, setOwner, setShortValueDescriptionAttribute, setValueDescriptionAttribute, setValueSeparationString

 

Methods inherited from class oracle.olapi.metadata.mdm.MdmDimension
getCardinality, getCustomOrder, getPluralDescription, getPrimaryDimension, getShortPluralDescription, setCardinality, setCustomOrder, setPluralDescription, setShortPluralDescription

 

Methods inherited from class oracle.olapi.metadata.mdm.MdmSource
getDataType, getSource

 

Methods inherited from class oracle.olapi.metadata.mdm.MdmObject
addDescription, addObjectClassification, findOrCreateDescription, getDescription, getDescription, getDescription, getDescriptions, getMetadataProvider, getName, getNewName, getObjectClassifications, getShortDescription, isClassifiedAs, removeDescription, removeObjectClassification, setDescription, setDescription, setDescription, setName, setShortDescription

 

Methods inherited from class oracle.olapi.metadata.BaseMetadataObject
getContainedByObject, getID

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Method Detail

acceptVisitor

public java.lang.Object acceptVisitor(MdmObjectVisitor visitor,
                                      java.lang.Object context)
Calls the visitMdmStandardDimension method of the MdmObjectVisitor and passes that method the MdmStandardDimension and an Object.
Specified by:
acceptVisitor in class MdmObject
Parameters:
visitor - An MdmObjectVisitor.
context - An Object.
Returns:
The Object returned by the visitMdmStandardDimension method.

createCustomMember

public MdmStandardMember createCustomMember(java.lang.String name,
                                            MdmLevel level,
                                            java.lang.String parent,
                                            Source source,
                                            int precedence)
Creates a custom dimension member for the MdmStandardDimension. For example, the following code creates a custom member of the Product dimension at the ITEM level. In the example, calc1 defines a calculation that produces the measure value for the dimension member for a measure dimensioned by the dimension.
 MdmStandardMember myProdMember = mdmProdStdDim.createCustomMember(
                                                            "EXE and STD",
                                                            mdmItemLevel,
                                                            "LTPC",
                                                            calc1,
                                                            10);
Parameters:
name - A String that contains the local value for the member.
level - The MdmLevel to which you want the member to belong.
parent - A String that contains the local value of the parent of the member. The parent must be a member of the level that is one level above the level to which the custom member belongs.
source - A Source that specifies the value of the custom member; this value is the measure value that is specified by the custom member for an MdmMeasure that is dimensioned by the MdmStandardDimension.
precedence - An integer that specifies the precedence for the custom member.
Returns:
An MdmStandardMember that is a custom member of the dimension.
See Also:
FundamentalMetadataProvider

createCustomMember

public MdmStandardMember createCustomMember(java.lang.String name,
                                            MdmLevel level,
                                            java.lang.String parent,
                                            MdmLevel parentLevel,
                                            Source source,
                                            int precedence)
Creates a custom dimension member with the specified parent level for the MdmStandardDimension.
Parameters:
name - A String that contains the local value for the member.
level - The MdmLevel to which you want the member to belong.
parent - A String that contains the local value of the parent of the member.
parentLevel - The MdmLevel to which the parent of the member belongs.
source - A Source that specifies the value of the custom member; this value is the measure value that is specified by the custom member for an MdmMeasure that is dimensioned by the MdmStandardDimension.
precedence - An integer that specifies the precedence for the custom member.
Returns:
An MdmStandardMember that is a custom member of the dimension.

createCustomMember

public MdmStandardMember createCustomMember(java.lang.String name,
                                            MdmValueHierarchy valueHier,
                                            Source source,
                                            int precedence)
Creates a custom dimension member for an MdmValueHierarchy component of the MdmStandardDimension.
Parameters:
name - A String that contains the local value for the member.
valueHier - The MdmValueHierarchy to which you want the member to belong.
source - A Source that specifies the value of the custom member; this value is the measure value that is specified by the custom member for an MdmMeasure that is dimensioned by the MdmStandardDimension.
precedence - An integer that specifies the precedence for the custom member.
Returns:
An MdmStandardMember that is a custom member of the dimension.

getCustomMembers

public final java.util.List getCustomMembers()
Gets the custom members of the MdmStandardDimension.
Returns:
A List that contains the MdmStandardMember objects that are the custom members of the MdmStandardDimension.

addCustomMember

public final void addCustomMember(MdmStandardMember customMember)
Adds a custom member to the MdmStandardDimension. Use this method to add a custom member that you create with the constructor of the MdmStandardMember class.
Parameters:
customMember - The custom MdmStandardMember to add to the MdmStandardDimension.

removeCustomMember

public final void removeCustomMember(MdmStandardMember customMember)
Removes a custom member from the MdmStandardDimension.
Parameters:
customMember - The custom MdmStandardMember to remove from the MdmStandardDimension.

Skip navigation links

Copyright © 2002, 2010, Oracle. All rights reserved.