oracle.olapi.data.source
Class FundamentalMetadataProvider

java.lang.Object
  |
  +--oracle.olapi.data.source.FundamentalMetadataProvider

public final class FundamentalMetadataProvider

extends java.lang.Object

implements MetadataProvider

Provides FundamentalMetadataObject objects that represent data types, functions, and function parameters used by the Oracle OLAP API. You get a FundamentalMetadataProvider with the getFundamentalMetadataProvider method of a DataProvider.

Typically, application programmers only use the methods of this class that get a FundamentalMetadataObject that represents an OLAP API data type, such as the getBooleanDataType method, or the methods that get a placeholder for an OLAP API data type, such as the getStringPlaceholder method. These methods are documented.

You use the Source returned by the getSource method of a FundamentalMetadataObject for a placeholder in defining a Source to use as the value for the source parameter for a method that creates a custom member of a dimension or as the value of the assigned parameter for an assign method of a Model. For example, the following code gets the placeholder for the Number data type and gets the Source for the placeholder. It uses that Source to define a calculation. The example then uses the calculation as the source parameter to create a custom member. In the example, dp is the DataProvider, mdmProdStdDim is an MdmStandardDimension, and itemLevel is an MdmLevel of a hierarchy of the dimension.

 // Get the placeholder Source for the Number data type.
 Source ph = dp.getFundamentalMetadataProvider()
               .getNumberPlaceholder()
               .getSource();

 // Create a Source that specifies a value for the custom member.
 Source calc1 = ((NumberSource)
                 (ph.join(prodRollup, "PRODUCT_ROLLUP::ITEM::14")))
                 .plus(
                 (NumberSource)
                 (ph.join(prodRollup, "PRODUCT_ROLLUP::ITEM::15")));

 // Create a custom member of the Product dimension.
 MdmStandardMember myProdMember = mdmProdStdDim.createCustomMember(
                                        "60",  // member local value
                                        itemLevel, // member level
                                        "4",   // parent local value
                                        calc1, // calculation of value for member
                                        10);   // precedence value

An application programmer does not use the methods that get the FundamentalMetadataObject objects that represent Oracle OLAP API functions and their parameters. Those methods are used by internal Oracle OLAP programmers or programmers who are creating custom providers of data and metadata. For this reason, those methods of this class are not documented.

Method Summary

FundamentalMetadataObject	getBooleanDataType() Gets the FundamentalMetadataObject that represents the OLAP API Boolean data type.
FundamentalMetadataObject	getBooleanPlaceholder() Gets the FundamentalMetadataObject that represents the OLAP API Boolean placeholder.
FundamentalMetadataObject	getDateDataType() Gets the FundamentalMetadataObject that represents the OLAP API Date data type.
FundamentalMetadataObject	getDatePlaceholder() Gets the FundamentalMetadataObject that represents the OLAP API Date placeholder.
FundamentalMetadataObject	getDoubleDataType() Gets the FundamentalMetadataObject that represents the OLAP API Double data type.
FundamentalMetadataObject	getEmptyDataType() Gets the FundamentalMetadataObject that represents the OLAP API Empty data type.
FundamentalMetadataObject	getFloatDataType() Gets the FundamentalMetadataObject that represents the OLAP API Float data type.
java.lang.String	getID() Gets the unique identifier for this FundamentalMetadataProvider.
FundamentalMetadataObject	getIntegerDataType() Gets the FundamentalMetadataObject that represents the OLAP API Integer data type.
FundamentalMetadataObject	getMetadataObject(java.lang.String id) Gets the FundamentalMetadataObject that has the specified identifier.
java.util.List	getMetadataObjects(java.lang.String[] ids) Retrieves a List in which each element is a FundamentalMetadataObject that has one of the specified identifiers.
FundamentalMetadataObject	getNumberDataType() Gets the FundamentalMetadataObject that represents the OLAP API Number data type.
FundamentalMetadataObject	getNumberPlaceholder() Gets the FundamentalMetadataObject that represents the OLAP API Number placeholder.
FundamentalMetadataObject	getShortDataType() Gets the FundamentalMetadataObject that represents the OLAP API Short data type.
FundamentalMetadataObject	getStringDataType() Gets the FundamentalMetadataObject that represents the OLAP API String data type.
FundamentalMetadataObject	getStringPlaceholder() Gets the FundamentalMetadataObject that represents the OLAP API String placeholder.
FundamentalMetadataObject	getValueDataType() Gets the FundamentalMetadataObject that represents the OLAP API Value data type.
FundamentalMetadataObject	getValuePlaceholder() Gets the FundamentalMetadataObject that represents the OLAP API Value placeholder.
FundamentalMetadataObject	getVoidDataType() Gets the FundamentalMetadataObject that represents the OLAP API Void data type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getID

public final java.lang.String getID()

Gets the unique identifier for this FundamentalMetadataProvider.

Specified by:

getID in interface MetadataProvider

Returns:

The unique identifier for this FundamentalMetadataProvider.

getMetadataObject

public final FundamentalMetadataObject getMetadataObject(java.lang.String id)

Gets the FundamentalMetadataObject that has the specified identifier.

Parameters:

id - A String that uniquely identifies the FundamentalMetadataObject to be retrieved.

Returns:

The requested FundamentalMetadataObject.

getMetadataObjects

public final java.util.List getMetadataObjects(java.lang.String[] ids)

Retrieves a List in which each element is a FundamentalMetadataObject that has one of the specified identifiers.

Parameters:

id - An array of String objects, each of which uniquely identifies a FundamentalMetadataObject to be retrieved.

Returns:

A List that contains a FundamentalMetadataObject for each of the specified identifiers.

getValueDataType

public final FundamentalMetadataObject getValueDataType()

Gets the FundamentalMetadataObject that represents the OLAP API Value data type. When the values of the elements of a Source object are any combination of the OLAP API Number, String, or Empty data types, the Source object has the OLAP API Value data type.

Returns:

A FundamentalMetadataObject that represents the OLAP API Value data type.

getEmptyDataType

public final FundamentalMetadataObject getEmptyDataType()

Gets the FundamentalMetadataObject that represents the OLAP API Empty data type. When a Source object has the OLAP API data type of Empty, it does not have any elements.

Returns:

A FundamentalMetadataObject that represents the OLAP API Empty data type.

getVoidDataType

public final FundamentalMetadataObject getVoidDataType()

Gets the FundamentalMetadataObject that represents the OLAP API Void data type. When a Source object has the OLAP API data type of Void, it one element, which has a null value.

Returns:

A FundamentalMetadataObject that represents the OLAP API Void data type.

getBooleanDataType

public final FundamentalMetadataObject getBooleanDataType()

Gets the FundamentalMetadataObject that represents the OLAP API Boolean data type. When a Source object has the OLAP API data type of Boolean, all of the values of its elements have the Java boolean data type.

Returns:

A FundamentalMetadataObject that represents the OLAP API Boolean data type.

getStringDataType

public final FundamentalMetadataObject getStringDataType()

Gets the FundamentalMetadataObject that represents the OLAP API String data type. When a Source object has the OLAP API data type of String, all of the values of its elements are Java String objects.

Returns:

A FundamentalMetadataObject that represents the OLAP API String data type.

getNumberDataType

public final FundamentalMetadataObject getNumberDataType()

Gets the FundamentalMetadataObject that represents the OLAP API Number data type. When the values of the elements of a Source object are any combination of the OLAP API numerical data types (that is, Double, Float, Integer, or Short), the Source object has the OLAP API Number data type.

Returns:

A FundamentalMetadataObject that represents the OLAP API Number data type.

getShortDataType

public final FundamentalMetadataObject getShortDataType()

Gets the FundamentalMetadataObject that represents the OLAP API Short data type. When a Source object has the OLAP API data type of Short, all of the values of its elements have the Java short data type.

Returns:

A FundamentalMetadataObject that represents the OLAP API Short data type.

getIntegerDataType

public final FundamentalMetadataObject getIntegerDataType()

Gets the FundamentalMetadataObject that represents the OLAP API Integer data type. When a Source object has the OLAP API data type of Integer, all of the values of its elements have the Java int data type.

Returns:

A FundamentalMetadataObject that represents the OLAP API Integer data type.

getFloatDataType

public final FundamentalMetadataObject getFloatDataType()

Gets the FundamentalMetadataObject that represents the OLAP API Float data type. When a Source object has the OLAP API data type of Float, all of the values of its elements have the Java float data type.

Returns:

A FundamentalMetadataObject that represents the OLAP API Float data type.

getDoubleDataType

public final FundamentalMetadataObject getDoubleDataType()

Gets the FundamentalMetadataObject that represents the OLAP API Double data type. When a Source object has the OLAP API data type of Double, all of the values of its elements have the Java double data type.

Returns:

A FundamentalMetadataObject that represents the OLAP API Double data type.

getDateDataType

public final FundamentalMetadataObject getDateDataType()

Gets the FundamentalMetadataObject that represents the OLAP API Date data type. When a Source object has the OLAP API data type of Date, all of the values of its elements are Java Date objects.

Returns:

A FundamentalMetadataObject that represents the OLAP API Date data type.

getValuePlaceholder

public final FundamentalMetadataObject getValuePlaceholder()

Gets the FundamentalMetadataObject that represents the OLAP API Value placeholder.

Returns:

A FundamentalMetadataObject that represents the OLAP API Value placeholder.

getBooleanPlaceholder

public final FundamentalMetadataObject getBooleanPlaceholder()

Gets the FundamentalMetadataObject that represents the OLAP API Boolean placeholder.

Returns:

A FundamentalMetadataObject that represents the OLAP API Boolean placeholder.

getStringPlaceholder

public final FundamentalMetadataObject getStringPlaceholder()

Gets the FundamentalMetadataObject that represents the OLAP API String placeholder.

Returns:

A FundamentalMetadataObject that represents the OLAP API String placeholder.

getDatePlaceholder

public final FundamentalMetadataObject getDatePlaceholder()

Gets the FundamentalMetadataObject that represents the OLAP API Date placeholder.

Returns:

A FundamentalMetadataObject that represents the OLAP API Date placeholder.

getNumberPlaceholder

public final FundamentalMetadataObject getNumberPlaceholder()

Gets the FundamentalMetadataObject that represents the OLAP API Number placeholder.

Returns:

A FundamentalMetadataObject that represents the OLAP API Number placeholder.