Oracle OLAP Java API Reference: Class MdmTimeDimension

Overview

Package

Class

Tree

Deprecated

Index

Help

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

oracle.olapi.metadata.mdm
Class MdmTimeDimension

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
                                |
                                +--oracle.olapi.metadata.mdm.MdmTimeDimension

public final class MdmTimeDimension
extends MdmPrimaryDimension

An MdmPrimaryDimension that represents an Oracle OLAP dimension of time periods.

Method Summary
`java.lang.Object`	`acceptVisitor(MdmObjectVisitor visitor, java.lang.Object context)` Calls the `visitMdmTimeDimension` method of the specified `MdmObjectVisitor` and passes that method this `MdmStandardDimension` and the specified `context` object.
`MdmAttribute`	`createEndDateAttribute(MtmValueExpression defaultExpression)` Creates a custom `MdmAttribute` and makes it the end date attribute for this `MdmTimeDimension`.
`MdmAttribute`	`createTimeSpanAttribute(MtmValueExpression defaultExpression)` Creates a custom `MdmAttribute` and makes it the time span attribute for this `MdmTimeDimension`.
`MdmAttribute`	`getEndDateAttribute()` Gets an `MdmAttribute` that relates each element of the `MdmSubDimension` components of this `MdmTimeDimension` element to the end date of the time period that the element represents.
`MdmAttribute`	`getTimeSpanAttribute()` Gets an `MdmAttribute` that relates each element of the `MdmSubDimension` components of this `MdmTimeDimension` element to the time span of the time period that the element represents.

Methods inherited from class oracle.olapi.metadata.mdm.MdmPrimaryDimension

createBooleanAttribute, createBooleanAttribute, createDateAttribute, createDateAttribute, createLevelHierarchy, createNumericAttribute, createNumericAttribute, createSolvedLevelHierarchy, createStringAttribute, createStringAttribute, createUnsolvedLevelHierarchy, createValueHierarchy, getAncestorsAttribute, getDefaultHierarchy, getHierarchies, getLevelAttribute, getLevelDepthAttribute, getLocalValueAttribute, getParentAttribute, getPrimaryDimension, getShortValueDescriptionAttribute, getValueDescriptionAttribute, getValueSeparationString, removeHierarchy, setDefaultHierarchy, setShortValueDescriptionAttribute, setValueDescriptionAttribute, setValueSeparationString

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

acceptVisitor

public java.lang.Object acceptVisitor(MdmObjectVisitor visitor,
                                      java.lang.Object context)

Calls the visitMdmTimeDimension method of the specified MdmObjectVisitor and passes that method this MdmStandardDimension and the specified context object.

Parameters:: visitor - An MdmObjectVisitor.; context - An Object.
Returns:: The Object returned by the MdmObjectVisitor.
Overrides:: acceptVisitor in class MdmObject

getEndDateAttribute

public final MdmAttribute getEndDateAttribute()

Gets an MdmAttribute that relates each element of the MdmSubDimension components of this MdmTimeDimension element to the end date of the time period that the element represents.

Returns:: An MdmAttribute that relates each element of the MdmSubDimension components of this MdmTimeDimension element to the end date of the time period that the element represents.

getTimeSpanAttribute

public final MdmAttribute getTimeSpanAttribute()

Gets an MdmAttribute that relates each element of the MdmSubDimension components of this MdmTimeDimension element to the time span of the time period that the element represents.

Returns:: An MdmAttribute that relates each element of the MdmSubDimension components of this MdmTimeDimension element to the time span of the time period that the element represents.

createEndDateAttribute

public MdmAttribute createEndDateAttribute(MtmValueExpression defaultExpression)

Creates a custom MdmAttribute and makes it the end date attribute for this MdmTimeDimension.

Parameters:: defaultExpression - An MtmValueExpression with a data type of Date that specifies end date values for the elements of this dimension. The expression should be independent of any hierarchy; that is, it should be a constant expression or it should be based on columns that appear in the tables of all of the hierarchies in this dimension.
Returns:: An MdmAttribute that is the end date attribute of this MdmTimeDimension.

createTimeSpanAttribute

public MdmAttribute createTimeSpanAttribute(MtmValueExpression defaultExpression)

Creates a custom MdmAttribute and makes it the time span attribute for this MdmTimeDimension.

Parameters:: defaultExpression - An MtmValueExpression with a data type of Number that specifies time span values for the elements of this dimension. The expression should be independent of any hierarchy; that is, it should be a constant expression or it should be based on columns that appear in the tables of all of the hierarchies in this dimension.
Returns:: An MdmAttribute that is the end date attribute of this MdmTimeDimension.