Oracle OLAP Java API Reference: Class MdmSource

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 MdmSource

java.lang.Object
  |
  +--oracle.olapi.metadata.BaseMetadataObject
        |
        +--oracle.olapi.metadata.mdm.MdmObject
              |
              +--oracle.olapi.metadata.mdm.MdmSource

Direct Known Subclasses:: MdmDimension, MdmDimensionedObject

public abstract class MdmSource
extends MdmObject

An MdmObject that represents a measure, dimension, or other set of data (such as an attribute). Thus, this abstract class is the basis for some important MDM metadata classes, such as the following concrete subclasses of MdmSource:

MdmAttribute
MdmLevelHierarchy
MdmLevel
MdmMeasure
MdmStandardDimension

To retrieve the data values that an MdmSource represents, an application calls the getSource method of the MdmSource. The method returns a Source that an application can use to create queries on the data that this MdmSource represents.

A Source returned by the getSource method of an MdmSource is called a primary Source. An application creates a query by using a method of the primary Source to specify a selection of its elements, or a calculation or some other manipulation of the data.

Method Summary
`FundamentalMetadataObject`	`getDataType()` Gets the OLAP API data type of this `MdmSource`.
`Source`	`getSource()` Gets the primary `Source` through which an application can create queries on the data represented by this `MdmSource`.
`MtmSourceMap`	`getSourceMap()` Gets the `MtmSourceMap` for this `MdmSource`.
`MetadataObject`	`getType()` Gets the type of this `MdmSource`.

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

getDataType

public FundamentalMetadataObject getDataType()

Gets the OLAP API data type of this MdmSource. The data type is a FundamentalMetadataObject that represents one of the following OLAP API data types:

Boolean
Double
Integer
Float
Short
String
Number (a general type that represents any of the numeric OLAP API data types, which are Integer, Double, Float, and Short)
Value (a general type that represents any OLAP API data type)

Returns:: The FundamentalMetadataObject that represents the OLAP API data type of this MdmSource.

getSourceMap

public final MtmSourceMap getSourceMap()
                                throws MetadataNotFoundException

Gets the MtmSourceMap for this MdmSource. The MtmSourceMap maps the elements of this MdmSource to data in the relational database.

Returns:: The MtmSourceMap for this MdmSource.

getSource

public final Source getSource()

Gets the primary Source through which an application can create queries on the data represented by this MdmSource.

The returned Source has no outputs. If this MdmSource is an MdmDimension, then the returned Source has no inputs. If the MdmSource is an MdmDimensionedObject (an MdmMeasure or an MdmAttribute), then the returned Source has inputs that correspond to the dimensions of the MdmDimensionedObject.

Returns:: The Source through which an application can create queries on the data represented by this MdmSource.

getType

public MetadataObject getType()

Gets the type of this MdmSource. The type is the MetadataObject whose elements provide the pool from which the MdmSource draws its elements. Typically, the type is either an MdmSource or a FundamentalMetadataObject that represents an OLAP API data type such as String, Integer, or Boolean.

Returns:: The MetadataObject that is the type of this MdmSource.