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, MdmStandardMember, 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 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 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() Gets the MtmSourceMap for the MdmSource.
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, 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 the 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)

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 final 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 MetadataNotFoundException

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

Returns:

The MtmSourceMap for the MdmSource.

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 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 final void setModel(MdmModel model)

Specifies an MdmModel for the MdmSource.

Parameters:

The - MdmModel that you want the MdmSource to have.