|
Oracle OLAP Java API Reference 10g Release 1 (10.1) B10994-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.MdmSubDimension | +--oracle.olapi.metadata.mdm.MdmHierarchy | +--oracle.olapi.metadata.mdm.MdmLevelHierarchy
An MdmHierarchy
that represents elements of an Oracle OLAP dimension that are organized either nonhierarchically or hierarchically by levels. An MdmLevelHierarchy
has component MdmLevel
objects. A nonhierarchical MdmLevelHierarchy
has only one MdmLevel
component, and a hierarchical MdmLevelHierarchy
has more than one MdmLevel
components. The hierarchical organization is defined by parent-child relationships between the elements of the MdmLevel
components.
MdmAttribute
objects record the parent-child relationships among the elements of an MdmLevelHierarchy
You use the getParentAttribute
and getAncestorsAttribute
methods to get the MdmAttribute
objects that relate parents to children and ancestors to descendents, respectively.
The MdmLevelHierarchy
has all of the elements of its MdmLevel
components. Each of its component MdmLevel
objects has the elements of the hierarchy for that level. For example, an MdmLevelHierarchy
for a calendar year time hierarchy might have parent-child relationships organized at year, quarter, month, and day levels. The MdmLevelHierarchy
would have the elements at every level. It would also have four component MdmLevel
objects, one for each level.
For the methods that return a custom MdmLevel
, this MdmLevelHierarchy
must be an unsolved level hierarchy, which is an MdmLevelHierarchy
that has an MtmUnsolvedLevelHierarchyMap
. If the expression
parameter specifies an MtmValueExpression
that has an MtmDataType
that is nullable (an MtmDataType
whose isNullable
method returns true
), then the MtmUnsolvedLevelHierarchyMap
for this MdmLevelHierarchy
must be a skip-level hierarchy (an MtmUnsolvedLevelHierarchyMap
whose isSkipLevelHierarchy
method returns true
).
For the methods that return a custom MdmLevel
and that specify a levelNumber
input parameter, a levelNumber
of 0 (zero) specifies the highest aggregate level of the hierarchy. The MdmLevel
returned by the method is at the level you specify with levelNumber
. The MdmLevel
that previously occupied that position in the hierarchy and all MdmLevel
objects below it move down one position.
For the methods that return a custom MdmLevel
and that specify a parentLevel
input parameter, the MdmLevel
returned by the method occupies the position under the parent level, and any levels that were already below the parent level move down one position. For example, if this MdmLevelHierarchy
has four levels, named TOTAL_PRODUCT
, CLASS
, FAMILY
, and ITEM
, and you call a createNumericLevel
method using a name
of GROUP
and a levelNumber
of 1
, or a parentLevel
of TOTAL_PRODUCT
, then after the method completes the MdmLevelHierarchy
has five levels, and the CLASS
, FAMILY
, and ITEM
levels, which were the second, third, and fourth levels in the old hierarchy are now the third, fourth, and fifth levels, and GROUP
is the second level.
MtmDataType
, MtmUnsolvedLevelHierarchyMap
Method Summary | |
java.lang.Object |
acceptVisitor(MdmObjectVisitor visitor, java.lang.Object context) Calls the visitMdmLevelHierarchy method of the specified MdmObjectVisitor and passes that method this MdmLevelHierarchy and the specified context object. |
MdmLevel |
addLevel(java.lang.String name, MtmExpression levelExpression) Deprecated. As of Oracle, Release 1 (10.1), replaced by the methods that create an MdmLevel of a specific data type, such as createBooleanLevel , and so on. |
MdmLevel |
createBooleanLevel(java.lang.String name, MtmValueExpression expression, int levelNumber) Creates a custom MdmLevel that has a data type of Boolean and the values specified by expression , and adds it to this MdmLevelHierarchy at the level position specified by levelNumber . |
MdmLevel |
createBooleanLevel(java.lang.String name, MtmValueExpression expression, MdmLevel parentLevel) Creates a custom MdmLevel that has a data type of Boolean and the values specified by expression , and adds it to this MdmLevelHierarchy at a position below that of parentLevel . |
MdmLevel |
createBooleanLevel(java.lang.String name, java.lang.String expression, int levelNumber) Creates a custom MdmLevel that has a data type of Boolean and the values specified by expression , and adds it to this MdmLevelHierarchy at the specified position in the hierarchy. |
MdmLevel |
createBooleanLevel(java.lang.String name, java.lang.String expression, MdmLevel parentLevel) Creates a custom MdmLevel that has a data type of Boolean and the values specified by expression , and adds it to this MdmLevelHierarchy at a position below that of parentLevel . |
MdmLevel |
createDateLevel(java.lang.String name, MtmValueExpression expression, int levelNumber) Creates a custom MdmLevel that has a data type of Date and the values specified by expression , and adds it to this MdmLevelHierarchy at the level position specified by levelNumber . |
MdmLevel |
createDateLevel(java.lang.String name, MtmValueExpression expression, MdmLevel parentLevel) Creates a custom MdmLevel that has a data type of Date and the values specified by expression , and adds it to this MdmLevelHierarchy at a position below that of parentLevel . |
MdmLevel |
createDateLevel(java.lang.String name, java.lang.String expression, int levelNumber) Creates a custom MdmLevel that has a data type of Date and the values specified by expression , and adds it to this MdmLevelHierarchy at the specified position in the hierarchy. |
MdmLevel |
createDateLevel(java.lang.String name, java.lang.String expression, MdmLevel parentLevel) Creates a custom MdmLevel that has a data type of Date and the values specified by expression , and adds it to this MdmLevelHierarchy at a position below that of parentLevel . |
MdmLevel |
createNumericLevel(java.lang.String name, MtmValueExpression expression, int levelNumber) Creates a custom MdmLevel that has a data type of Number and the values specified by expression , and adds it to this MdmLevelHierarchy at the level position specified by levelNumber . |
MdmLevel |
createNumericLevel(java.lang.String name, MtmValueExpression expression, MdmLevel parentLevel) Creates a custom MdmLevel that has a data type of Number and the values specified by expression , and adds it to this MdmLevelHierarchy at a position below that of parentLevel . |
MdmLevel |
createNumericLevel(java.lang.String name, java.lang.String expression, int levelNumber) Creates a custom MdmLevel that has a data type of Number and the values specified by expression , and adds it to this MdmLevelHierarchy at the specified position in the hierarchy. |
MdmLevel |
createNumericLevel(java.lang.String name, java.lang.String expression, MdmLevel parentLevel) Creates a custom MdmLevel that has a data type of Number and the values specified by expression , and adds it to this MdmLevelHierarchy at a position below that of parentLevel . |
MdmLevel |
createStringLevel(java.lang.String name, MtmValueExpression expression, int levelNumber) Creates a custom MdmLevel that has a data type of String and the values specified by expression , and adds it to this MdmLevelHierarchy at the level position specified by levelNumber . |
MdmLevel |
createStringLevel(java.lang.String name, MtmValueExpression expression, MdmLevel parentLevel) Creates a custom MdmLevel that has a data type of String and the values specified by expression , and adds it to this MdmLevelHierarchy at a position below that of parentLevel . |
MdmLevel |
createStringLevel(java.lang.String name, java.lang.String expression, int levelNumber) Creates a custom MdmLevel that has a data type of String and the values specified by expression , and adds it to this MdmLevelHierarchy at the specified position in the hierarchy. |
MdmLevel |
createStringLevel(java.lang.String name, java.lang.String expression, MdmLevel parentLevel) Creates a custom MdmLevel that has a data type of String and the values specified by expression , and adds it to this MdmLevelHierarchy at a position below that of parentLevel . |
MdmDimensionMemberInfo |
getDefaultMember() Gets the default member of this MdmHierarchy . |
MdmAttribute |
getLevelAttribute() Gets the MdmAttribute that relates the elements of a component MdmLevel to a level in the hierarchy. |
MdmAttribute |
getLevelDepthAttribute() Gets the MdmAttribute that relates the elements of a component MdmLevel to the depth of a level in the hierarchy. |
MtmLevelHierarchyMap |
getLevelHierarchyMap() Gets the MtmLevelHierarchyMap for this MdmLevelHierarchy . |
java.util.List |
getLevels() Gets the MdmLevel components of this MdmLevelHierarchy . |
void |
removeLevel(MdmLevel level) Removes the specified level from this MdmLevelHierarchy . |
void |
setDefaultMember(MdmDimensionMemberInfo defaultMember) Sets the default member of this MdmHierarchy . |
Methods inherited from class oracle.olapi.metadata.mdm.MdmHierarchy |
getAncestorsAttribute, getParentAttribute, isDefaultHierarchy |
Methods inherited from class oracle.olapi.metadata.mdm.MdmSubDimension |
getPrimaryDimension |
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, getSource, getSourceMap, getType |
Methods inherited from class oracle.olapi.metadata.mdm.MdmObject |
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 java.lang.Object acceptVisitor(MdmObjectVisitor visitor, java.lang.Object context)
visitMdmLevelHierarchy
method of the specified MdmObjectVisitor
and passes that method this MdmLevelHierarchy
and the specified context
object.visitor
- An MdmObjectVisitor
.context
- An Object
.Object
returned by the visitMdmLevelHierarchy
method.public MdmLevel addLevel(java.lang.String name, MtmExpression levelExpression)
MdmLevel
of a specific data type, such as createBooleanLevel
, and so on.public final MdmAttribute getLevelAttribute()
MdmAttribute
that relates the elements of a component MdmLevel
to a level in the hierarchy.MdmAttribute
that relates the elements of the MdmLevel
components of this MdmLevelHierarchy
to a level in the hierarchy.public final MdmAttribute getLevelDepthAttribute()
MdmAttribute
that relates the elements of a component MdmLevel
to the depth of a level in the hierarchy. For example, an MdmLevelHierarchy
that represents a hierarchy that has four levels would have four component MdmLevel
objects. The elements of the MdmLevel
for the top level of the hierarchy have a level depth of 1, the elements of the MdmLevel
that are the children of the level 1 elements have a level depth of 2, and so on.MdmAttribute
that relates the elements of the MdmLevel
components of this MdmLevelHierarchy
to the depth of their level in the hierarchy.public MtmLevelHierarchyMap getLevelHierarchyMap() throws MetadataNotFoundException
MtmLevelHierarchyMap
for this MdmLevelHierarchy
. The MtmLevelHierarchyMap
maps the elements of this MdmLevelHierarchy
to data in the relational database.MtmLevelHierarchyMap
for this MdmLevelHierarchy
.MtmLevelHierarchyMap
public final java.util.List getLevels()
MdmLevel
components of this MdmLevelHierarchy
.List
that contains the MdmLevel
components of this MdmLevelHierarchy
.public MdmDimensionMemberInfo getDefaultMember() throws MetadataNotFoundException
MdmHierarchy
.MdmHierarchy
.MdmDimensionMemberInfo
public void setDefaultMember(MdmDimensionMemberInfo defaultMember) throws MetadataNotFoundException, MdmInvalidValueException
MdmHierarchy
.defaultMember
- The value of the new default member of this MdmHierarchy
.MdmDimensionMemberInfo
public void removeLevel(MdmLevel level)
MdmLevelHierarchy
.level
- The MdmLevel
to remove as a component of the hierarchy.public MdmLevel createNumericLevel(java.lang.String name, MtmValueExpression expression, int levelNumber)
MdmLevel
that has a data type of Number and the values specified by expression
, and adds it to this MdmLevelHierarchy
at the level position specified by levelNumber
. For restrictions on using this method, see Creating Levels in the description of this class.name
- A String
that specifies a name for the custom MdmLevel
.expression
- An MtmValueExpression
that specifies the values for the level.levelNumber
- An integer that specifies the position of the custom level in the hierarchy.MdmLevel
that has a data type of Number and that is at the specified position in the hierarchy.MdmCustomObjectFactory.createNumericLevel(String, MdmLevelHierarchy, MtmValueExpression, int)
public MdmLevel createNumericLevel(java.lang.String name, java.lang.String expression, int levelNumber)
MdmLevel
that has a data type of Number and the values specified by expression
, and adds it to this MdmLevelHierarchy
at the specified position in the hierarchy. For restrictions on using this method, see Creating Levels in the description of this class.name
- A String
that specifies a name for the custom MdmLevel
.expression
- A String
that specifies the values for the elements of the level.levelNumber
- An integer that specifies the position of the custom level in the hierarchy.MdmLevel
that has a data type of Number and that is at the specified position in the hierarchy.MdmCustomObjectFactory.createNumericLevel(String, MdmLevelHierarchy, String, int)
public MdmLevel createNumericLevel(java.lang.String name, MtmValueExpression expression, MdmLevel parentLevel)
MdmLevel
that has a data type of Number and the values specified by expression
, and adds it to this MdmLevelHierarchy
at a position below that of parentLevel
. For restrictions on using this method, see Creating Levels in the description of this class.name
- A String
that specifies a name for the custom MdmLevel
.expression
- An MtmValueExpression
that specifies the values for the elements of the level.parentLevel
- An MdmLevel
whose elements are the parents of the elements of the MdmLevel
returned by this method.MdmLevel
that has a data type of Number and that has a position in the hierarchy below that of parentLevel
.MdmCustomObjectFactory.createNumericLevel(String, MdmLevelHierarchy, MtmValueExpression, MdmLevel)
public MdmLevel createNumericLevel(java.lang.String name, java.lang.String expression, MdmLevel parentLevel)
MdmLevel
that has a data type of Number and the values specified by expression
, and adds it to this MdmLevelHierarchy
at a position below that of parentLevel
. For restrictions on using this method, see Creating Levels in the description of this class.name
- A String
that specifies a name for the custom MdmLevel
.expression
- A String
that specifies the values for the elements of the level.parentLevel
- An MdmLevel
whose elements are the parents of the elements of the MdmLevel
returned by this method.MdmLevel
that has a data type of Number and that has a position in the hierarchy below that of parentLevel
.MdmCustomObjectFactory.createNumericLevel(String, MdmLevelHierarchy, String, MdmLevel)
public MdmLevel createStringLevel(java.lang.String name, MtmValueExpression expression, int levelNumber)
MdmLevel
that has a data type of String and the values specified by expression
, and adds it to this MdmLevelHierarchy
at the level position specified by levelNumber
. For restrictions on using this method, see Creating Levels in the description of this class.name
- A String
that specifies a name for the custom MdmLevel
.expression
- An MtmValueExpression
that specifies the values for the level.levelNumber
- An integer that specifies the position of the custom level in the hierarchy.MdmLevel
that has a data type of String and that is at the specified position in the hierarchy.MdmCustomObjectFactory.createStringLevel(String, MdmLevelHierarchy, MtmValueExpression, int)
public MdmLevel createStringLevel(java.lang.String name, java.lang.String expression, int levelNumber)
MdmLevel
that has a data type of String and the values specified by expression
, and adds it to this MdmLevelHierarchy
at the specified position in the hierarchy. For restrictions on using this method, see Creating Levels in the description of this class.name
- A String
that specifies a name for the custom MdmLevel
.expression
- A String
that specifies the values for the elements of the level.levelNumber
- An integer that specifies the position of the custom level in the hierarchy.MdmLevel
that has a data type of String and that is at the specified position in the hierarchy.MdmCustomObjectFactory.createStringLevel(String, MdmLevelHierarchy, String, int)
public MdmLevel createStringLevel(java.lang.String name, MtmValueExpression expression, MdmLevel parentLevel)
MdmLevel
that has a data type of String and the values specified by expression
, and adds it to this MdmLevelHierarchy
at a position below that of parentLevel
. For restrictions on using this method, see Creating Levels in the description of this class.name
- A String
that specifies a name for the custom MdmLevel
.expression
- An MtmValueExpression
that specifies the values for the elements of the level.parentLevel
- An MdmLevel
whose elements are the parents of the elements of the MdmLevel
returned by this method.MdmLevel
that has a data type of String and that has a position in the hierarchy below that of parentLevel
.MdmCustomObjectFactory.createStringLevel(String, MdmLevelHierarchy, MtmValueExpression, MdmLevel)
public MdmLevel createStringLevel(java.lang.String name, java.lang.String expression, MdmLevel parentLevel)
MdmLevel
that has a data type of String and the values specified by expression
, and adds it to this MdmLevelHierarchy
at a position below that of parentLevel
. For restrictions on using this method, see Creating Levels in the description of this class.name
- A String
that specifies a name for the custom MdmLevel
.expression
- A String
that specifies the values for the elements of the level.parentLevel
- An MdmLevel
whose elements are the parents of the elements of the MdmLevel
returned by this method.MdmLevel
that has a data type of String and that has a position in the hierarchy below that of parentLevel
.MdmCustomObjectFactory.createStringLevel(String, MdmLevelHierarchy, String, MdmLevel)
public MdmLevel createDateLevel(java.lang.String name, MtmValueExpression expression, int levelNumber)
MdmLevel
that has a data type of Date and the values specified by expression
, and adds it to this MdmLevelHierarchy
at the level position specified by levelNumber
. For restrictions on using this method, see Creating Levels in the description of this class.name
- A String
that specifies a name for the custom MdmLevel
.expression
- An MtmValueExpression
that specifies the values for the level.levelNumber
- An integer that specifies the position of the custom level in the hierarchy.MdmLevel
that has a data type of Date and that is at the specified position in the hierarchy.MdmCustomObjectFactory.createDateLevel(String, MdmLevelHierarchy, MtmValueExpression, int)
public MdmLevel createDateLevel(java.lang.String name, java.lang.String expression, int levelNumber)
MdmLevel
that has a data type of Date and the values specified by expression
, and adds it to this MdmLevelHierarchy
at the specified position in the hierarchy. For restrictions on using this method, see Creating Levels in the description of this class.name
- A String
that specifies a name for the custom MdmLevel
.expression
- A String
that specifies the values for the elements of the level.levelNumber
- An integer that specifies the position of the custom level in the hierarchy.MdmLevel
that has a data type of Date and that is at the specified position in the hierarchy.MdmCustomObjectFactory.createDateLevel(String, MdmLevelHierarchy, String, int)
public MdmLevel createDateLevel(java.lang.String name, MtmValueExpression expression, MdmLevel parentLevel)
MdmLevel
that has a data type of Date and the values specified by expression
, and adds it to this MdmLevelHierarchy
at a position below that of parentLevel
. For restrictions on using this method, see Creating Levels in the description of this class.name
- A String
that specifies a name for the custom MdmLevel
.expression
- An MtmValueExpression
that specifies the values for the elements of the level.parentLevel
- An MdmLevel
whose elements are the parents of the elements of the MdmLevel
returned by this method.MdmLevel
that has a data type of Date and that has a position in the hierarchy below that of parentLevel
.MdmCustomObjectFactory.createDateLevel(String, MdmLevelHierarchy, MtmValueExpression, MdmLevel)
public MdmLevel createDateLevel(java.lang.String name, java.lang.String expression, MdmLevel parentLevel)
MdmLevel
that has a data type of Date and the values specified by expression
, and adds it to this MdmLevelHierarchy
at a position below that of parentLevel
. For restrictions on using this method, see Creating Levels in the description of this class.name
- A String
that specifies a name for the custom MdmLevel
.expression
- A String
that specifies the values for the elements of the level.parentLevel
- An MdmLevel
whose elements are the parents of the elements of the MdmLevel
returned by this method.MdmLevel
that has a data type of Date and that has a position in the hierarchy below that of parentLevel
.MdmCustomObjectFactory.createDateLevel(String, MdmLevelHierarchy, String, MdmLevel)
public MdmLevel createBooleanLevel(java.lang.String name, MtmValueExpression expression, int levelNumber)
MdmLevel
that has a data type of Boolean and the values specified by expression
, and adds it to this MdmLevelHierarchy
at the level position specified by levelNumber
. For restrictions on using this method, see Creating Levels in the description of this class.name
- A String
that specifies a name for the custom MdmLevel
.expression
- An MtmValueExpression
that specifies the values for the level.levelNumber
- An integer that specifies the position of the custom level in the hierarchy.MdmLevel
that has a data type of Boolean and that is at the specified position in the hierarchy.MdmCustomObjectFactory.createBooleanLevel(String, MdmLevelHierarchy, MtmValueExpression, int)
public MdmLevel createBooleanLevel(java.lang.String name, java.lang.String expression, int levelNumber)
MdmLevel
that has a data type of Boolean and the values specified by expression
, and adds it to this MdmLevelHierarchy
at the specified position in the hierarchy. For restrictions on using this method, see Creating Levels in the description of this class.name
- A String
that specifies a name for the custom MdmLevel
.expression
- A String
that specifies the values for the elements of the level.levelNumber
- An integer that specifies the position of the custom level in the hierarchy.MdmLevel
that has a data type of Boolean and that is at the specified position in the hierarchy.MdmCustomObjectFactory.createBooleanLevel(String, MdmLevelHierarchy, String, int)
public MdmLevel createBooleanLevel(java.lang.String name, MtmValueExpression expression, MdmLevel parentLevel)
MdmLevel
that has a data type of Boolean and the values specified by expression
, and adds it to this MdmLevelHierarchy
at a position below that of parentLevel
. For restrictions on using this method, see Creating Levels in the description of this class.name
- A String
that specifies a name for the custom MdmLevel
.expression
- An MtmValueExpression
that specifies the values for the elements of the level.parentLevel
- An MdmLevel
whose elements are the parents of the elements of the MdmLevel
returned by this method.MdmLevel
that has a data type of Boolean and that has a position in the hierarchy below that of parentLevel
.MdmCustomObjectFactory.createBooleanLevel(String, MdmLevelHierarchy, MtmValueExpression, MdmLevel)
public MdmLevel createBooleanLevel(java.lang.String name, java.lang.String expression, MdmLevel parentLevel)
MdmLevel
that has a data type of Boolean and the values specified by expression
, and adds it to this MdmLevelHierarchy
at a position below that of parentLevel
. For restrictions on using this method, see Creating Levels in the description of this class.name
- A String
that specifies a name for the custom MdmLevel
.expression
- A String
that specifies the values for the elements of the level.parentLevel
- An MdmLevel
whose elements are the parents of the elements of the MdmLevel
returned by this method.MdmLevel
that has a data type of Boolean and that has a position in the hierarchy below that of parentLevel
.MdmCustomObjectFactory.createBooleanLevel(String, MdmLevelHierarchy, String, MdmLevel)
|
Oracle OLAP Java API Reference 10g Release 1 (10.1) B10994-01 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |