|
Oracle® OLAP Java API Reference 11g Release 1 (11.1) B28128-01 |
||||||||
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.MdmObject
public abstract class MdmObject
An object that describes a particular set of data, such as a measure of product unit prices or a dimension of time values. This class is the basic implementation of the MetadataObject
interface.
An MdmObject
has only the most fundamental properties, so very few specific data characteristics are associated with it. Classes that extend this class or one of its subclasses, such as MdmSchema
and MdmPrimaryDimension
, have characteristics that support metadata creation, navigation, and analysis. An application gets MdmObject
objects from an MdmMetadataProvider
.
MetadataObject
Method Summary | |
---|---|
abstract java.lang.Object |
acceptVisitor(MdmObjectVisitor visitor, java.lang.Object context) Calls a method of the specified MdmObjectVisitor and passes that method this MdmObject and an Object . |
MdmDescription |
findOrCreateDescription(MdmDescriptionType type, java.lang.String language, java.lang.String value) Gets the MdmDescription of the specified type and language, if it exists, and specifies the value of the description. |
java.lang.String |
getDescription() Gets a descriptive phrase for this MdmObject . |
java.lang.String |
getDescription(MdmDescriptionType type) Gets a description of the specified type for this MdmObject in the default language for the current session. |
java.lang.String |
getDescription(MdmDescriptionType type, java.lang.String language) Gets a description of the specified type for this MdmObject in the specified.language. |
MdmMetadataProvider |
getMetadataProvider() Gets the MdmMetadataProvider for this MdmObject . |
java.lang.String |
getName() Gets the name of this MdmObject . |
java.lang.String |
getShortDescription() Gets the short description for this MdmObject . |
void |
setDescription(MdmDescriptionType type, java.lang.String value) Specifies a description of the specified type for this MdmObject in the default language for the current session. |
void |
setDescription(MdmDescriptionType type, java.lang.String language, java.lang.String value) Specifies a description of the specified type for this MdmObject in the specified language. |
void |
setDescription(java.lang.String description) Specifies a descriptive phrase for this MdmObject . |
void |
setName(java.lang.String name) Specifies a name for this MdmObject . |
void |
setShortDescription(java.lang.String description) Specifies a short description for this MdmObject . |
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 |
---|
public abstract java.lang.Object acceptVisitor(MdmObjectVisitor visitor, java.lang.Object context)
MdmObjectVisitor
and passes that method this MdmObject
and an Object
.visitor
- An MdmObjectVisitor
.context
- An Object
.Object
returned by a method of the MdmObjectVisitor
.public final java.lang.String getDescription() throws oracle.express.mdm.MetadataNotFoundException
MdmObject
.MdmObject
.oracle.express.mdm.MetadataNotFoundException
public MdmMetadataProvider getMetadataProvider()
MdmMetadataProvider
for this MdmObject
.MdmMetadataProvider
for this MdmObject
.public java.lang.String getName() throws oracle.express.mdm.MetadataNotFoundException
MdmObject
.String
that contains the name of this MdmObject
.oracle.express.mdm.MetadataNotFoundException
public java.lang.String getShortDescription() throws oracle.express.mdm.MetadataNotFoundException
MdmObject
. You can use this description for display in a graphical user interface instead of the return value of the getName
method.String
containing the short description of this MdmObject
.oracle.express.mdm.MetadataNotFoundException
public final void setDescription(java.lang.String description)
MdmObject
.description
- A String
that contains a description for this MdmObject
.public void setName(java.lang.String name)
MdmObject
.name
- A String
that contains a name for this MdmObject
.public void setShortDescription(java.lang.String description) throws oracle.express.mdm.MetadataNotFoundException
MdmObject
. You can use this description for display in a graphical user interface instead of the return value of the getName
method.description
- A String
that contains a short description for this MdmObject
.oracle.express.mdm.MetadataNotFoundException
public final java.lang.String getDescription(MdmDescriptionType type)
MdmObject
in the default language for the current session.type
- An MdmDescriptionType
that specifies the type of description, such as name or long description.String
that contains the descriptive value of the MdmDescription
associated with the specified MdmDescriptionType
.public final java.lang.String getDescription(MdmDescriptionType type, java.lang.String language)
MdmObject
in the specified.language.type
- An MdmDescriptionType
that specifies the type of description, such as short name or plural description.language
- A String
that specifies the language for the description.String
that contains the descriptive value of the MdmDescription
associated with the specified MdmDescriptionType
.public final void setDescription(MdmDescriptionType type, java.lang.String value)
MdmObject
in the default language for the current session.type
- An MdmDescriptionType
that specifies the type of description, such as name or long description.value
- A String
that contains the description for this MdmObject
.public final void setDescription(MdmDescriptionType type, java.lang.String language, java.lang.String value)
MdmObject
in the specified language.type
- An MdmDescriptionType
that specifies the type of description, such as name or long description.language
- A String
that specifies the language for the description.value
- A String
that contains the description for this MdmObject
.public MdmDescription findOrCreateDescription(MdmDescriptionType type, java.lang.String language, java.lang.String value)
MdmDescription
of the specified type and language, if it exists, and specifies the value of the description. Otherwise, creates an MdmDescription
of the specified type and language with the specified value.type
- An MdmDescriptionType
that specifies the type of description, such as name or long description.language
- A String
that specifies the language for the description.value
- A String
that contains the description for this MdmObject
.MdmDescription
of specified type and language with the specified value.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |