Skip navigation links

Oracle® OLAP Java API Reference
11g Release 1 (11.1)

B28128-03


oracle.olapi.metadata.mdm
Class MdmSource

java.lang.Object
  extended by oracle.olapi.metadata.BaseMetadataObject
      extended by oracle.olapi.metadata.mdm.MdmObject
          extended by oracle.olapi.metadata.mdm.MdmSource

All Implemented Interfaces:
MetadataObject
Direct Known Subclasses:
MdmColumn, MdmDimension, MdmDimensionedObject, MdmStandardMember, MdmTable, MdmTimeMember

public abstract class MdmSource
extends MdmObject

An MdmObject that represents a measure, dimension, or other set of data (such as an attribute). 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 the MdmSource represents.

A Source returned by the getSource method of an MdmSource is a primary Source. An application creates a query by using a method of the primary Source to create a derived Source that specifies 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 the MdmSource.
 MdmModel getModel()
          Gets the MdmModel for an MdmMeasure or an MdmAttribute, which are the subclasses of MdmDimensionedObject.
 Source getSource()
          Gets the primary Source through which an application can create queries on the data represented by the MdmSource.
 MtmSourceMap getSourceMap()
          Deprecated. As of Oracle 11g, Release 1 (11.1); replaced by methods of some of the subclasses of MdmSource, such as the findOrCreateMemberListMap method of an MdmPrimaryDimension.
abstract  MetadataObject getType()
          Gets the type of the MdmSource.
 void setModel(MdmModel model)
          Specifies an MdmModel for the MdmSource.

 

Methods inherited from class oracle.olapi.metadata.mdm.MdmObject
acceptVisitor, addDescription, addObjectClassification, findOrCreateDescription, getDescription, getDescription, getDescription, getDescriptions, getMetadataProvider, getName, getObjectClassifications, getShortDescription, isClassifiedAs, removeDescription, removeObjectClassification, setDescription, setDescription, setDescription, setName, setShortDescription

 

Methods inherited from class oracle.olapi.metadata.BaseMetadataObject
getID, getOwner

 

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 the MdmSource. The data type is a FundamentalMetadataObject that represents one of the following OLAP API data types:

In this documentation, the OLAP API data types appear in regular font to distinguish them from the Java data types, such as boolean, and the classes that encapsulate them, such as Boolean. The Java data types and classes appear in monospace font.

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

getModel

public MdmModel getModel()
Gets the MdmModel for an MdmMeasure or an MdmAttribute, which are the subclasses of MdmDimensionedObject. For other MdmSource objects, this method returns null.
Returns:
The MdmModel for an MdmMeasure or an MdmAttribute, or null for other MdmSource objects.

getSourceMap

public final MtmSourceMap getSourceMap()
                                throws oracle.express.mdm.MetadataNotFoundException
Deprecated. As of Oracle 11g, Release 1 (11.1); replaced by methods of some of the subclasses of MdmSource, such as the findOrCreateMemberListMap method of an MdmPrimaryDimension.
Throws:
oracle.express.mdm.MetadataNotFoundException

getSource

public final Source getSource()
Gets the primary Source through which an application can create queries on the data represented by the MdmSource.

The returned Source has no outputs. If the 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:
A Source through which an application can create queries on the data represented by the MdmSource.

getType

public abstract MetadataObject getType()
Gets the type of the 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 the MdmSource.

setModel

public void setModel(MdmModel model)
Specifies an MdmModel for the MdmSource.
Parameters:
model - The MdmModel to associate with the MdmSource.

Skip navigation links

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