|
Oracle® OLAP Java API Reference 11g Release 2 (11.2) E10794-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.olapi.metadata.BaseMetadataObject
oracle.olapi.metadata.mdm.MdmDescription
public final class MdmDescription
A BaseMetadataObject
that represents a description for an MdmObject
. The Oracle OLAP Java API provides various types of descriptions, which are represented by instances of the MdmDescriptionType
class. That class has static methods that return objects that represent a type of description, such as a name, a long name, a description, a short description, and others. An application can add to the available types of description by defining a new MdmDescriptionType
.
To find or create an MdmDescription
, use the findOrCreateDescription
method of an MdmObject
. See the
method for an example.getType
Method Summary | |
---|---|
MdmObject |
getDescribedObject() Gets the MdmObject that this MdmDescription describes. |
java.lang.String |
getLanguage() Gets the language that is associated with this MdmDescription . |
java.lang.String |
getName() Gets the name of this MetadataObject . |
java.lang.String |
getType() Gets the type of description that this MdmDescription represents. |
java.lang.String |
getValue() Gets the value that of this MdmDescription . |
void |
setValue(java.lang.String value) Specifies the value of this MdmDescription . |
Methods inherited from class oracle.olapi.metadata.BaseMetadataObject |
---|
getContainedByObject, getID, getNewName, getOwner |
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 getType()
MdmDescription
represents. For example, the following code gets the type of an MdmDescription
for mdmStdDim
, which is an MdmStandardDimension
.
MdmDescription mdmDescr = mdmStdDim.findOrCreateDescription( MdmDescriptionType.getShortNameDescriptionType(), "AMERICAN", "MyDim"); String type = mdmDescr.getType(); System.out.println("The type of the MdmDescription is " + type + ".");The output of the example is the following.
The type of the MdmDescription is ShortName.
String
that contains the type of description of this MdmDescription
.public final java.lang.String getLanguage()
MdmDescription
.String
that identifies the language associated with this MdmDescription
.public final java.lang.String getValue()
MdmDescription
.String
that is the value of this MdmDescription
.public final void setValue(java.lang.String value)
MdmDescription
.value
- A String
that specifies the value for this MdmDescription
.public final MdmObject getDescribedObject()
MdmObject
that this MdmDescription
describes.MdmObject
that owns this MdmDescription
.public java.lang.String getName()
MetadataObject
.getName
in class BaseMetadataObject
String
that contains the name of this MetadataObject
.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |