Oracle® OLAP Java API Reference
10g Release 2 (10.2.0.4)

B14348-04

oracle.olapi.metadata.mdm
Class MdmLevel

java.lang.Object
  extended byoracle.olapi.metadata.BaseMetadataObject
      extended byoracle.olapi.metadata.mdm.MdmObject
          extended byoracle.olapi.metadata.mdm.MdmSource
              extended byoracle.olapi.metadata.mdm.MdmDimension
                  extended byoracle.olapi.metadata.mdm.MdmSubDimension
                      extended byoracle.olapi.metadata.mdm.MdmLevel
All Implemented Interfaces:
MetadataObject

public class MdmLevel
extends MdmSubDimension

An MdmSubDimension whose members comprise one level of an MdmLevelHierarchy. If the MdmLevelHierarchy has more than one component MdmLevel, then the MdmLevelHierarchy has a hierarchical structure that is specified by parent-child relationships between the members of the MdmLevel components. Those parent-child relationships are recorded by MdmAttribute objects that you can get with the getParentAttribute and getAncestorsAttribute methods of the MdmLevelHierarchy.

The getType method returns the type of data that the MdmLevel represents. Because an MdmLevel is a component of an MdmLevelHierarchy, the type of an MdmLevel is its MdmLevelHierarchy.


Field Summary
static java.lang.String LEVELTYPE_DAY
          A constant that specifies a level type of DAY.
static java.lang.String LEVELTYPE_HALFYEAR
          A constant that specifies a level type of HALFYEAR.
static java.lang.String LEVELTYPE_HOUR
          A constant that specifies a level type of HOUR.
static java.lang.String LEVELTYPE_MINUTE
          A constant that specifies a level type of MINUTE.
static java.lang.String LEVELTYPE_MONTH
          A constant that specifies a level type of MONTH.
static java.lang.String LEVELTYPE_QUARTER
          A constant that specifies a level type of QUARTER.
static java.lang.String LEVELTYPE_SECOND
          A constant that specifies a level type of SECOND.
static java.lang.String LEVELTYPE_STANDARD
          A constant that specifies a level type of STANDARD.
static java.lang.String LEVELTYPE_WEEK
          A constant that specifies a level type of WEEK.
static java.lang.String LEVELTYPE_YEAR
          A constant that specifies a level type of YEAR.
 
Method Summary
 java.lang.Object acceptVisitor(MdmObjectVisitor visitor, java.lang.Object context)
          Calls the visitMdmLevel method of the specified MdmObjectVisitor and passes that method this MdmLevel and the specified context object.
 int getLevelDepth()
          Gets the depth of this MdmLevel in the hierarchy of levels of the MdmHierarchy of which this level is a component.
 MdmLevelHierarchy getLevelHierarchy()
          Gets the MdmLevelHierarchy of which this MdmLevel is a component.
 MtmLevelMap getLevelMap()
          Gets the MtmLevelMap for this MdmLevel.
 java.lang.String getLevelType()
          Returns the type of information that this MdmLevel represents.
 void setLevelType(java.lang.String levelType)
          Specifies the type of information that this MdmLevel represents.
 
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, getModel, getSource, getSourceMap, getType, setModel
 
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
 

Field Detail

LEVELTYPE_STANDARD

public static final java.lang.String LEVELTYPE_STANDARD
A constant that specifies a level type of STANDARD.

See Also:
Constant Field Values

LEVELTYPE_YEAR

public static final java.lang.String LEVELTYPE_YEAR
A constant that specifies a level type of YEAR.

See Also:
Constant Field Values

LEVELTYPE_HALFYEAR

public static final java.lang.String LEVELTYPE_HALFYEAR
A constant that specifies a level type of HALFYEAR.

See Also:
Constant Field Values

LEVELTYPE_QUARTER

public static final java.lang.String LEVELTYPE_QUARTER
A constant that specifies a level type of QUARTER.

See Also:
Constant Field Values

LEVELTYPE_MONTH

public static final java.lang.String LEVELTYPE_MONTH
A constant that specifies a level type of MONTH.

See Also:
Constant Field Values

LEVELTYPE_WEEK

public static final java.lang.String LEVELTYPE_WEEK
A constant that specifies a level type of WEEK.

See Also:
Constant Field Values

LEVELTYPE_DAY

public static final java.lang.String LEVELTYPE_DAY
A constant that specifies a level type of DAY.

See Also:
Constant Field Values

LEVELTYPE_HOUR

public static final java.lang.String LEVELTYPE_HOUR
A constant that specifies a level type of HOUR.

See Also:
Constant Field Values

LEVELTYPE_MINUTE

public static final java.lang.String LEVELTYPE_MINUTE
A constant that specifies a level type of MINUTE.

See Also:
Constant Field Values

LEVELTYPE_SECOND

public static final java.lang.String LEVELTYPE_SECOND
A constant that specifies a level type of SECOND.

See Also:
Constant Field Values
Method Detail

acceptVisitor

public java.lang.Object acceptVisitor(MdmObjectVisitor visitor,
                                      java.lang.Object context)
Calls the visitMdmLevel method of the specified MdmObjectVisitor and passes that method this MdmLevel and the specified context object.

Specified by:
acceptVisitor in class MdmObject
Parameters:
visitor - An MdmObjectVisitor.
context - An Object.
Returns:
The Object returned by the visitMdmLevel method.

getLevelHierarchy

public MdmLevelHierarchy getLevelHierarchy()
Gets the MdmLevelHierarchy of which this MdmLevel is a component.

Returns:
The MdmLevelHierarchy of which this MdmLevel is a component.

getLevelMap

public MtmLevelMap getLevelMap()
                        throws MetadataNotFoundException
Gets the MtmLevelMap for this MdmLevel. The MtmLevelMap maps the members of this MdmLevel to data in the relational database.

Returns:
The MtmLevelMap for this MdmLevel.
Throws:
MetadataNotFoundException
See Also:
MtmLevelMap

getLevelType

public java.lang.String getLevelType()
                              throws MetadataNotFoundException
Returns the type of information that this MdmLevel represents. For an MdmTimeDimension, the possible levelType values are YEAR, HALFYEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, and SECOND. For an MdmStandardDimension or MdmMeasureDimension, the level type is STANDARD.

Returns:
A String indicating the type of information in this level.
Throws:
MetadataNotFoundException

setLevelType

public void setLevelType(java.lang.String levelType)
                  throws MdmInvalidValueException
Specifies the type of information that this MdmLevel represents. For an MdmTimeDimension, the possible levelType values are YEAR, HALFYEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, and SECOND. For an MdmStandardDimension or MdmMeasureDimension, the level type is STANDARD.

Parameters:
levelType - A String indicating the type of the information in this level.
Throws:
MdmInvalidValueException

getLevelDepth

public int getLevelDepth()
Gets the depth of this MdmLevel in the hierarchy of levels of the MdmHierarchy of which this level is a component.

Returns:
An integer that indicates the level depth of this level in a hierarchy of levels.

Oracle® OLAP Java API Reference
10g Release 2 (10.2.0.4)

B14348-04

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