|
Oracle® OLAP Java API Reference 10g Release 2 (10.2.0.4) B14348-04 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectoracle.olapi.data.source.FundamentalMetadataProvider
Provides FundamentalMetadataObject objects that represent data
types, functions, and function parameters used by the OLAP Java 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 Java API
data type, such as the getBooleanDataType method, or the methods
that get a placeholder for an OLAP Java 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(prodHier, ""PRODUCT_PRIMARY_AW::ITEM_AW::14")))
.plus(
(NumberSource)
(ph.join(prodHier, ""PRODUCT_PRIMARY_AW::ITEM_AW::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 OLAP Java
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 Java API Boolean data type. |
FundamentalMetadataObject |
getBooleanPlaceholder()
Gets the FundamentalMetadataObject that
represents the OLAP Java API Boolean placeholder. |
FundamentalMetadataObject |
getDateDataType()
Gets the FundamentalMetadataObject that
represents the OLAP Java API Date data type. |
FundamentalMetadataObject |
getDatePlaceholder()
Gets the FundamentalMetadataObject that
represents the OLAP Java API Date placeholder. |
FundamentalMetadataObject |
getDoubleDataType()
Gets the FundamentalMetadataObject that
represents the OLAP Java API Double data type. |
FundamentalMetadataObject |
getEmptyDataType()
Gets the FundamentalMetadataObject that
represents the OLAP Java API Empty data type. |
FundamentalMetadataObject |
getFloatDataType()
Gets the FundamentalMetadataObject that
represents the OLAP Java API Float data type. |
java.lang.String |
getID()
Gets the unique identifier for this FundamentalMetadataProvider. |
FundamentalMetadataObject |
getIntegerDataType()
Gets the FundamentalMetadataObject that
represents the OLAP Java 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 Java API Number data type. |
FundamentalMetadataObject |
getNumberPlaceholder()
Gets the FundamentalMetadataObject that
represents the OLAP Java API Number placeholder. |
FundamentalMetadataObject |
getShortDataType()
Gets the FundamentalMetadataObject that
represents the OLAP Java API Short data type. |
FundamentalMetadataObject |
getStringDataType()
Gets the FundamentalMetadataObject that
represents the OLAP Java API String data type. |
FundamentalMetadataObject |
getStringPlaceholder()
Gets the FundamentalMetadataObject that
represents the OLAP Java API String placeholder. |
FundamentalMetadataObject |
getValueDataType()
Gets the FundamentalMetadataObject that
represents the OLAP Java API Value data type. |
FundamentalMetadataObject |
getValuePlaceholder()
Gets the FundamentalMetadataObject that
represents the OLAP Java API Value placeholder. |
FundamentalMetadataObject |
getVoidDataType()
Gets the FundamentalMetadataObject that
represents the OLAP Java API Void data type. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
public final java.lang.String getID()
FundamentalMetadataProvider.
getID in interface MetadataProviderFundamentalMetadataProvider.public final FundamentalMetadataObject getMetadataObject(java.lang.String id)
FundamentalMetadataObject that has the specified
identifier.
id - A String that uniquely identifies the
FundamentalMetadataObject to be retrieved.
FundamentalMetadataObject.public final java.util.List getMetadataObjects(java.lang.String[] ids)
List in which each element is a
FundamentalMetadataObject that has one of the specified
identifiers.
ids - An array of String objects, each of which
uniquely identifies a FundamentalMetadataObject.
List that contains the specified
FundamentalMetadataObject objects.public final FundamentalMetadataObject getValueDataType()
FundamentalMetadataObject that
represents the OLAP Java API Value data type.
When the values of the elements of a
Source object are
any combination of the
OLAP Java API Number, String, or Empty data types,
the Source object
has the OLAP Java API Value data type.
FundamentalMetadataObject that
represents the OLAP Java API Value data type.public final FundamentalMetadataObject getEmptyDataType()
FundamentalMetadataObject that
represents the OLAP Java API Empty data type.
When a Source object has the OLAP Java API data type of Empty,
it does not have any elements.
FundamentalMetadataObject that
represents the OLAP Java API Empty data type.public final FundamentalMetadataObject getVoidDataType()
FundamentalMetadataObject that
represents the OLAP Java API Void data type.
When a Source object has the OLAP Java API data type of Void,
it one element, which has a null value.
FundamentalMetadataObject that
represents the OLAP Java API Void data type.public final FundamentalMetadataObject getBooleanDataType()
FundamentalMetadataObject that
represents the OLAP Java API Boolean data type.
When a Source object has the
OLAP Java API data type of Boolean,
all of the values of its elements have the Java
boolean data type.
FundamentalMetadataObject that
represents the OLAP Java API Boolean data type.public final FundamentalMetadataObject getStringDataType()
FundamentalMetadataObject that
represents the OLAP Java API String data type.
When a Source object has the
OLAP Java API data type of String,
all of the values of its elements are Java String objects.
FundamentalMetadataObject that
represents the OLAP Java API String data type.public final FundamentalMetadataObject getNumberDataType()
FundamentalMetadataObject that
represents the OLAP Java API Number data type.
When the values of the elements of a
Source object are
any combination of the
OLAP Java API numerical data types (that is,
Double, Float, Integer, or Short),
the Source object
has the OLAP Java API Number data type.
FundamentalMetadataObject that
represents the OLAP Java API Number data type.public final FundamentalMetadataObject getShortDataType()
FundamentalMetadataObject that
represents the OLAP Java API Short data type.
When a Source object has the
OLAP Java API data type of Short,
all of the values of its elements have the Java
short data type.
FundamentalMetadataObject that
represents the OLAP Java API Short data type.public final FundamentalMetadataObject getIntegerDataType()
FundamentalMetadataObject that
represents the OLAP Java API Integer data type.
When a Source object has the
OLAP Java API data type of Integer,
all of the values of its elements have the Java
int data type.
FundamentalMetadataObject that
represents the OLAP Java API Integer data type.public final FundamentalMetadataObject getFloatDataType()
FundamentalMetadataObject that
represents the OLAP Java API Float data type.
When a Source object has the
OLAP Java API data type of Float,
all of the values of its elements have the Java
float data type.
FundamentalMetadataObject that
represents the OLAP Java API Float data type.public final FundamentalMetadataObject getDoubleDataType()
FundamentalMetadataObject that
represents the OLAP Java API Double data type.
When a Source object has the
OLAP Java API data type of Double,
all of the values of its elements have the Java
double data type.
FundamentalMetadataObject that
represents the OLAP Java API Double data type.public final FundamentalMetadataObject getDateDataType()
FundamentalMetadataObject that
represents the OLAP Java API Date data type.
When a Source object has the
OLAP Java API data type of Date,
all of the values of its elements are Java
Date objects.
FundamentalMetadataObject that
represents the OLAP Java API Date data type.public final FundamentalMetadataObject getValuePlaceholder()
FundamentalMetadataObject that
represents the OLAP Java API Value placeholder.
FundamentalMetadataObject that
represents the OLAP Java API Value placeholder.public final FundamentalMetadataObject getBooleanPlaceholder()
FundamentalMetadataObject that
represents the OLAP Java API Boolean placeholder.
FundamentalMetadataObject that
represents the OLAP Java API Boolean placeholder.public final FundamentalMetadataObject getStringPlaceholder()
FundamentalMetadataObject that
represents the OLAP Java API String placeholder.
FundamentalMetadataObject that
represents the OLAP Java API String placeholder.public final FundamentalMetadataObject getDatePlaceholder()
FundamentalMetadataObject that
represents the OLAP Java API Date placeholder.
FundamentalMetadataObject that
represents the OLAP Java API Date placeholder.public final FundamentalMetadataObject getNumberPlaceholder()
FundamentalMetadataObject that
represents the OLAP Java API Number placeholder.
FundamentalMetadataObject that
represents the OLAP Java API Number placeholder.
|
Oracle® OLAP Java API Reference 10g Release 2 (10.2.0.4) B14348-04 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||