|
Oracle® OLAP Java API Reference 10g Release 2 (10.2) B14348-01 |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
|
+--oracle.olapi.metadata.BaseMetadataObject
|
+--oracle.olapi.metadata.mdm.MdmObject
|
+--oracle.olapi.metadata.mdm.MdmSource
|
+--oracle.olapi.metadata.mdm.MdmDimension
|
+--oracle.olapi.metadata.mdm.MdmPrimaryDimension
An MdmDimension that represents an Oracle OLAP dimension. An MdmPrimaryDimension has one or more MdmHierarchy components.
The concrete subclasses of the abstract MdmPrimaryDimension class represent different types of data. Most dimensions are MdmStandardDimension objects, which typically has members that represent products, customers, distribution channels, and so on. Another type of dimension is the MdmTimeDimension, which has members that represent time periods. A third type of dimension is a MdmMeasureDimension, which has members that are MdmMeasure objects.
The MdmHierarchy components of an MdmPrimaryDimension represent organizations of the members of the dimension. An Oracle OLAP dimension can be a simple, nonhierarchical set of members, or it have its members organized into one or more hierarchies. A hierarchy can have parent-child relationships organized by levels or by values. For example, a dimension of time periods might be organized into two hierarchies, one organized by calendar year time periods and the other organized by fiscal year time periods. Both hierarchies are organized by levels for year, quarter, month, and day time periods. Each of those hierarchies is represented by an MdmLevelHierarchy, which is a concrete subclass of the abstract MdmHierarchy class. Those MdmLevelHierarchy objects are the components of the MdmTimeDimension.
Some the methods of an MdmPrimaryDimension return MdmAttribute objects that have members that are related to members of one or more of the components of the dimension. For example, the getLocalValueAttribute method returns an MdmAttribute that relates the unique value of a member of a component of the MdmPrimaryDimension to its corresponding local value. A unique value specifies a hierarchy, a level of the hierarchy, and the value of a member in that level, as in the following example from an MdmLevelHierarchy that represents products organized into levels by the type of product.
PRODUCT_ROLLUP::FAMILY::8
The parts of the unique value are separated by a value separation string. The value separation string in the preceding example is ::, the double colons. The local value of that unique value is 8.
You initially get MdmPrimaryDimension objects from an instance of an MdmSchema or an MdmMeasure. The getDimensions methods of those objects return lists of MdmPrimaryDimension objects that are MdmStandardDimension or MdmTimeDimension objects. You get the MdmMeasureDimension by calling the getMeasureDimension method on the MdmSchema returned by the getRootSchema method of the MdmMetadataProvider that you are using.
| Method Summary | |
MdmAttribute |
createBooleanAttribute(java.lang.String name, MtmValueExpression expression)Creates a custom MdmAttribute that has a data type of Boolean, that has the data specified by expression, and that is dimensioned by the MdmPrimaryDimension. |
MdmAttribute |
createBooleanAttribute(java.lang.String name, java.lang.String expression)Creates a custom MdmAttribute that has a data type of Boolean, that has the data specified by expression, and that is dimensioned by the MdmPrimaryDimension. |
MdmAttribute |
createDateAttribute(java.lang.String name, MtmValueExpression expression)Creates a custom MdmAttribute that has a data type of Date, that has the data specified by expression, and that is dimensioned by the MdmPrimaryDimension. |
MdmAttribute |
createDateAttribute(java.lang.String name, java.lang.String expression)Creates a custom MdmAttribute that has a data type of Date, that has the data specified by expression, and that is dimensioned by the MdmPrimaryDimension. |
MdmLevelHierarchy |
createLevelHierarchy(java.lang.String name, MdmLevelHierarchy prototype)Creates a custom MdmLevelHierarchy that is initially identical to the one specified by prototype and adds it to the MdmPrimaryDimension. |
MdmAttribute |
createNumericAttribute(java.lang.String name, MtmValueExpression expression)Creates a custom MdmAttribute that has a data type of Number, that has the data specified by expression, and that is dimensioned by the MdmPrimaryDimension. |
MdmAttribute |
createNumericAttribute(java.lang.String name, java.lang.String expression)Creates a custom MdmAttribute that has a data type of Number, that has the data specified by expression, and that is dimensioned by the MdmPrimaryDimension. |
MdmLevelHierarchy |
createSolvedLevelHierarchy(java.lang.String name, MtmTabularSource table, MtmValueExpression gidExpression, MtmValueExpression etExpression, MtmValueExpression parentGIDExpression, MtmValueExpression parentETExpression)Creates a custom MdmLevelHierarchy that has an MtmSolvedLevelHierarchyMap that has the specified MtmTabularSource and expressions, and adds it to the MdmPrimaryDimension. |
MdmAttribute |
createStringAttribute(java.lang.String name, MtmValueExpression expression)Creates a custom MdmAttribute that has a data type of String, that has the data specified by expression, and that is dimensioned by the MdmPrimaryDimension. |
MdmAttribute |
createStringAttribute(java.lang.String name, java.lang.String expression)Creates a custom MdmAttribute that has a data type of String, that has the data specified by expression, and that is dimensioned by the MdmPrimaryDimension. |
MdmLevelHierarchy |
createUnsolvedLevelHierarchy(java.lang.String name, MtmTabularSource table)Creates a custom MdmLevelHierarchy that has an MtmUnsolvedLevelHierarchyMap that has the specified name and MtmTabularSource adds it to the MdmPrimaryDimension. |
MdmValueHierarchy |
createValueHierarchy(java.lang.String name, MdmLevelHierarchy levelHierarchy)Creates a custom MdmValueHierarchy that is initially identical to the one specified by levelHierarchy and adds it to the MdmPrimaryDimension. |
MdmAttribute |
getAncestorsAttribute()Gets the ancestors attribute for the MdmPrimaryDimension. |
MdmDimensionCalculationModel |
getBooleanCalcModel()Gets the MdmDimensionCalculationModel that has a data type of Boolean. |
MdmDimensionCalculationModel |
getDateCalcModel()Gets the MdmDimensionCalculationModel that has a data type of Date. |
MdmHierarchy |
getDefaultHierarchy()Gets the default component of the MdmPrimaryDimension. |
java.util.List |
getHierarchies()Gets a List that contains the components of the MdmPrimaryDimension, which are MdmHierarchy objects. |
MdmAttribute |
getHierarchyAttribute()Gets the MdmAttribute that relates a hierarchy to each member of the MdmPrimaryDimension. |
MdmAttribute |
getIsCustomMemberAttribute()Gets the MdmAttribute that, for each member of the MdmPrimaryDimension, indicates whether that member is a custom member. |
MdmAttribute |
getLevelAttribute()Gets the MdmAttribute that relates the level of the hierarchy that a member of the hierarchy is in to each member of the MdmPrimaryDimension. |
MdmAttribute |
getLevelDepthAttribute()Gets the MdmAttribute that relates the depth of the level of the hierarchy that a member of the hierarchy is in to each member of the MdmPrimaryDimension. |
MdmAttribute |
getLocalValueAttribute()Gets the MdmAttribute that relates a local value to each member of the MdmPrimaryDimension. |
MdmDimensionCalculationModel |
getNumberCalcModel()Gets the MdmDimensionCalculationModel that has a data type of Number. |
MdmAttribute |
getParentAttribute()Gets the parent attribute for the MdmPrimaryDimension. |
MdmPrimaryDimension |
getPrimaryDimension()Gets the MdmPrimaryDimension. |
MdmAttribute |
getShortValueDescriptionAttribute()Gets the MdmAttribute that relates a short description to each member of the MdmPrimaryDimension. |
MdmDimensionCalculationModel |
getStringCalcModel()Gets the MdmDimensionCalculationModel that has a data type of String. |
MdmAttribute |
getValueDescriptionAttribute()Gets the MdmAttribute that relates a long description to each member MdmPrimaryDimension. |
MdmAttribute |
getValueLineageAttribute() |
java.lang.String |
getValueSeparationString()Returns the String that separates the hierarchy, level, and local value parts of the unique value of a member of the MdmPrimaryDimension. |
void |
removeHierarchy(MdmHierarchy hierarchy)Removes an MdmHierarchy from the components of the MdmPrimaryDimension. |
void |
setBooleanCalcModel(MdmDimensionCalculationModel model)Specifies an MdmDimensionCalculationModel to use for an MdmMeasure or MdmAttribute that has Boolean values. |
void |
setDateCalcModel(MdmDimensionCalculationModel model)Specifies an MdmDimensionCalculationModel to use for an MdmMeasure or MdmAttribute that has Date values. |
void |
setDefaultHierarchy(MdmHierarchy hierarchy)Specifies hierarchy as the default hierarchy for the MdmPrimaryDimension. |
void |
setNumberCalcModel(MdmDimensionCalculationModel model)Specifies an MdmDimensionCalculationModel to use for an MdmMeasure or MdmAttribute that has Number values. |
void |
setShortValueDescriptionAttribute(MdmAttribute attr)Specifes a short description value for members of the MdmPrimaryDimension. |
void |
setStringCalcModel(MdmDimensionCalculationModel model)Specifies an MdmDimensionCalculationModel to use for an MdmMeasure or MdmAttribute that has String values. |
void |
setValueDescriptionAttribute(MdmAttribute attr)Specifes a long description value for members of the MdmPrimaryDimension. |
void |
setValueSeparationString(java.lang.String sep)Specifies a String that separates the hierarchy, level, and local value parts of the unique value of a member of the MdmPrimaryDimension. |
| Methods inherited from class oracle.olapi.metadata.mdm.MdmDimension |
getAttributes, getCardinality, getPluralDescription, getShortPluralDescription, removeAttribute, setCardinality, setPluralDescription, setShortPluralDescription |
| Methods inherited from class oracle.olapi.metadata.mdm.MdmSource |
getDataType, getModel, getSource, getSourceMap, getType, setModel |
| Methods inherited from class oracle.olapi.metadata.mdm.MdmObject |
acceptVisitor, getDescription, getMetadataProvider, getName, getShortDescription, setDescription, setName, setShortDescription |
| Methods inherited from class oracle.olapi.metadata.BaseMetadataObject |
getID |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
public MdmAttribute getAncestorsAttribute()
throws MetadataNotFoundException
MdmPrimaryDimension. The ancestors attribute maps each member of the MdmHierarchy components of the MdmPrimaryDimension to its group of ancestors in the hierarchy. For example, the ancestors for a month in a time hierarchy might be quarter and year.MdmAttribute that is the ancestors attribute of the MdmPrimaryDimension.public final java.util.List getHierarchies()
List that contains the components of the MdmPrimaryDimension, which are MdmHierarchy objects.List that contains the components of the MdmPrimaryDimension.public MdmHierarchy getDefaultHierarchy()
MdmPrimaryDimension.MdmHierarchy that is the default component of the MdmPrimaryDimension.public final MdmPrimaryDimension getPrimaryDimension()
MdmPrimaryDimension.MdmPrimaryDimension.
public MdmAttribute getParentAttribute()
throws MetadataNotFoundException
MdmPrimaryDimension. The parent attribute maps each member of the MdmHierarchy components of the MdmPrimaryDimension to its parent.MdmAttribute that is the parent attribute of the MdmPrimaryDimension.
public final MdmAttribute getShortValueDescriptionAttribute()
throws MetadataNotFoundException
MdmAttribute that relates a short description to each member of the MdmPrimaryDimension.MdmAttribute that relates a short description to each member MdmPrimaryDimension.
public final MdmAttribute getValueDescriptionAttribute()
throws MetadataNotFoundException
MdmAttribute that relates a long description to each member MdmPrimaryDimension.MdmAttribute that relates a long description to each member of the components of the MdmPrimaryDimension.public final MdmAttribute getLevelAttribute()
MdmAttribute that relates the level of the hierarchy that a member of the hierarchy is in to each member of the MdmPrimaryDimension.MdmAttribute that relates a level of a hierarchy to each member of the MdmPrimaryDimension.public final MdmAttribute getLevelDepthAttribute()
MdmAttribute that relates the depth of the level of the hierarchy that a member of the hierarchy is in to each member of the MdmPrimaryDimension.MdmAttribute that relates the depth of a level in a hierarchy to each member of the MdmPrimaryDimension.
public final MdmAttribute getLocalValueAttribute()
throws MetadataNotFoundException
MdmAttribute that relates a local value to each member of the MdmPrimaryDimension.MdmAttribute that relates a local value to each member of the MdmPrimaryDimension.
public final MdmAttribute getHierarchyAttribute()
throws MetadataNotFoundException
MdmAttribute that relates a hierarchy to each member of the MdmPrimaryDimension.MdmAttribute that relates a hierarchy to each member of the MdmPrimaryDimension.
public final MdmAttribute getIsCustomMemberAttribute()
throws MetadataNotFoundException
MdmAttribute that, for each member of the MdmPrimaryDimension, indicates whether that member is a custom member.MdmAttribute that, for each member of the of the MdmPrimaryDimension, indicates whether that member is a custom member.
public final MdmAttribute getValueLineageAttribute()
throws MetadataNotFoundException
public final java.lang.String getValueSeparationString()
throws MetadataNotFoundException
String that separates the hierarchy, level, and local value parts of the unique value of a member of the MdmPrimaryDimension.MdmPrimaryDimension.
public MdmAttribute createNumericAttribute(java.lang.String name,
MtmValueExpression expression)
MdmAttribute that has a data type of Number, that has the data specified by expression, and that is dimensioned by the MdmPrimaryDimension.name - A String specifying the name of the custom MdmAttribute.expression - An MtmValueExpression that provides the data for the custom MdmAttribute.MdmAttribute with a data type of Number and the values specified by expression.
public MdmAttribute createNumericAttribute(java.lang.String name,
java.lang.String expression)
MdmAttribute that has a data type of Number, that has the data specified by expression, and that is dimensioned by the MdmPrimaryDimension.name - A String specifying the name of the custom MdmAttribute.expression - A String that specifies the data for the custom MdmMeasure. Oracle OLAP uses the String to construct an MtmCustomExpression that has the default numeric data type.MdmAttribute with a data type of Number and the values specified by expression.
public MdmAttribute createDateAttribute(java.lang.String name,
MtmValueExpression expression)
MdmAttribute that has a data type of Date, that has the data specified by expression, and that is dimensioned by the MdmPrimaryDimension.name - A String specifying the name of the custom MdmAttribute.expression - An MtmValueExpression that provides the data for the custom MdmAttribute.MdmAttribute with a data type of Date and the values specified by expression.
public MdmAttribute createDateAttribute(java.lang.String name,
java.lang.String expression)
MdmAttribute that has a data type of Date, that has the data specified by expression, and that is dimensioned by the MdmPrimaryDimension.name - A String specifying the name of the custom MdmAttribute.expression - A String that specifies the data for the custom MdmAttribute. Oracle OLAP uses the String to construct an MtmCustomExpression that has the String data type.MdmAttribute with a data type of Date and the values specified by expression.
public MdmAttribute createStringAttribute(java.lang.String name,
MtmValueExpression expression)
MdmAttribute that has a data type of String, that has the data specified by expression, and that is dimensioned by the MdmPrimaryDimension.name - A String specifying the name of the custom MdmAttribute.expression - An MtmValueExpression that provides the data for the custom MdmAttribute.MdmAttribute with a data type of String and the values specified by expression.
public MdmAttribute createStringAttribute(java.lang.String name,
java.lang.String expression)
MdmAttribute that has a data type of String, that has the data specified by expression, and that is dimensioned by the MdmPrimaryDimension.name - A String specifying the name of the custom MdmAttribute.expression - A String that provides the data for the custom MdmAttribute. Oracle OLAP uses the String to construct an MtmCustomExpression that has the String data type.MdmAttribute with a data type of String and the values specified by expression.
public MdmAttribute createBooleanAttribute(java.lang.String name,
MtmValueExpression expression)
MdmAttribute that has a data type of Boolean, that has the data specified by expression, and that is dimensioned by the MdmPrimaryDimension.name - A String specifying the name of the custom MdmAttribute.expression - An MtmValueExpression that provides the data for the custom MdmAttribute.MdmAttribute with a data type of Boolean and the values specified by expression.
public MdmAttribute createBooleanAttribute(java.lang.String name,
java.lang.String expression)
MdmAttribute that has a data type of Boolean, that has the data specified by expression, and that is dimensioned by the MdmPrimaryDimension.name - A String specifying the name of the custom MdmAttribute.expression - A String that provides the data for the custom MdmAttribute. Oracle OLAP uses the String to construct an MtmCustomExpression that has the String data type.MdmAttribute with a data type of Boolean and the values specified by expression.public void setDefaultHierarchy(MdmHierarchy hierarchy)
hierarchy as the default hierarchy for the MdmPrimaryDimension.hierarchy - The MdmHierarchy to set as the default hierarchy for the MdmPrimaryDimension.public void removeHierarchy(MdmHierarchy hierarchy)
MdmHierarchy from the components of the MdmPrimaryDimension.hierarchy - The MdmHierarchy to remove from the MdmPrimaryDimension
public MdmLevelHierarchy createLevelHierarchy(java.lang.String name,
MdmLevelHierarchy prototype)
MdmLevelHierarchy that is initially identical to the one specified by prototype and adds it to the MdmPrimaryDimension. You can change your custom MdmLevelHierarchy by, for example, adding or removing levels or custom members or attributes or by revising the MtmDimensionOrderSpecification objects of its MtmUnsolvedLevelHierarchyMap.
The prototype hierarchy must be an unsolved level hierarchy, which is an MdmLevelHierarchy that has an MtmUnsolvedLevelHierarchyMap. The custom MdmLevelHierarchy returned by this method has MtmUnsolvedCube objects that are copies of the MtmUnsolvedCube objects that are dimensioned by the prototype hierarchy.
name - A String that specifies a name for the custom MdmLevelHierarchy.prototype - An existing MdmLevelHierarchy that has an MtmUnsolvedLevelHierarchyMap.MdmLevelHierarchy that is initially a copy of prototype.
public MdmLevelHierarchy createUnsolvedLevelHierarchy(java.lang.String name,
MtmTabularSource table)
MdmLevelHierarchy that has an MtmUnsolvedLevelHierarchyMap that has the specified name and MtmTabularSource adds it to the MdmPrimaryDimension.name - A String that specifies a name for the custom MdmLevelHierarchy.table - The MtmTabularSource that represents the mapping of the relational database table or view to the dimensional hierarchy.MdmLevelHierarchy that is mapped to the relational table specified by table.MtmUnsolvedLevelHierarchyMap
public MdmLevelHierarchy createSolvedLevelHierarchy(java.lang.String name,
MtmTabularSource table,
MtmValueExpression gidExpression,
MtmValueExpression etExpression,
MtmValueExpression parentGIDExpression,
MtmValueExpression parentETExpression)
MdmLevelHierarchy that has an MtmSolvedLevelHierarchyMap that has the specified MtmTabularSource and expressions, and adds it to the MdmPrimaryDimension.name - A String that specifies a name for the custom MdmLevelHierarchy.table - The MtmTabularSource that represents the mapping of the relational database table or view to the dimensional hierarchy.gidExpression - An MtmValueExpression that specifies the GID column for the MtmSolvedLevelHierarchyMap of the custom MdmLevelHierarchy.etExpression - An MtmValueExpression that specifies the ET column for the MtmSolvedLevelHierarchyMap.parentGIDExpression - An MtmValueExpression that specifies the parent GID column for the MtmSolvedLevelHierarchyMap.parentETExpression - An MtmValueExpression that specifies the parent ET column for the MtmSolvedLevelHierarchyMap.MdmLevelHierarchy that is mapped to the relational table or view specified by table.MtmSolvedLevelHierarchyMap
public MdmValueHierarchy createValueHierarchy(java.lang.String name,
MdmLevelHierarchy levelHierarchy)
MdmValueHierarchy that is initially identical to the one specified by levelHierarchy and adds it to the MdmPrimaryDimension. The levelHierarchy object must be a component of the MdmPrimaryDimension and it must be an solved level hierarchy, which is an MdmLevelHierarchy that has an MtmSolvedLevelHierarchyMap.
You can change your custom MdmValueHierarchy by, for example, adding or removing custom members or attributes or by revising the MtmDimensionOrderSpecification objects of its MtmSolvedLevelHierarchyMap.
name - A String that specifies a name for the custom MdmValueHierarchy.levelHierarchy - An existing MdmLevelHierarchy that has an MtmSolvedLevelHierarchyMap and that is a component of this MdmPrimaryDimension.MdmLevelHierarchy that is initially a copy of levelHierarchy.public final void setShortValueDescriptionAttribute(MdmAttribute attr)
MdmPrimaryDimension.attr - An MdmAttribute that relates a short description to members of the MdmPrimaryDimension.public final void setValueDescriptionAttribute(MdmAttribute attr)
MdmPrimaryDimension.attr - An MdmAttribute that relates a long description to members of the MdmPrimaryDimension.public final void setValueSeparationString(java.lang.String sep)
String that separates the hierarchy, level, and local value parts of the unique value of a member of the MdmPrimaryDimension.sep - A String that you want to use as the value separation string for the parts of a unique value of a member of the MdmPrimaryDimension.public final MdmDimensionCalculationModel getBooleanCalcModel()
MdmDimensionCalculationModel that has a data type of Boolean.MdmDimensionCalculationModel that has a data type of Boolean.public final MdmDimensionCalculationModel getStringCalcModel()
MdmDimensionCalculationModel that has a data type of String.MdmDimensionCalculationModel that has a data type of String.public final MdmDimensionCalculationModel getDateCalcModel()
MdmDimensionCalculationModel that has a data type of Date.MdmDimensionCalculationModel that has a data type of Date.public final MdmDimensionCalculationModel getNumberCalcModel()
MdmDimensionCalculationModel that has a data type of Number.MdmDimensionCalculationModel that has a data type of Number.public final void setBooleanCalcModel(MdmDimensionCalculationModel model)
MdmDimensionCalculationModel to use for an MdmMeasure or MdmAttribute that has Boolean values.The - MdmDimensionCalculationModel to use for MdmDimensionedObject objects that have a data type of Boolean.public final void setStringCalcModel(MdmDimensionCalculationModel model)
MdmDimensionCalculationModel to use for an MdmMeasure or MdmAttribute that has String values.The - MdmDimensionCalculationModel to use for MdmDimensionedObject objects that have a data type of String.public final void setDateCalcModel(MdmDimensionCalculationModel model)
MdmDimensionCalculationModel to use for an MdmMeasure or MdmAttribute that has Date values.The - MdmDimensionCalculationModel to use for MdmDimensionedObject objects that have a data type of Date.public final void setNumberCalcModel(MdmDimensionCalculationModel model)
MdmDimensionCalculationModel to use for an MdmMeasure or MdmAttribute that has Number values.The - MdmDimensionCalculationModel to use for MdmDimensionedObject objects that have a data type of Number.
|
Oracle® OLAP Java API Reference 10g Release 2 (10.2) B14348-01 |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||