|
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.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. An MdmObject
has methods that get or set the following characteristics of the object.
In addition to a name, an MdmObject
can have other decriptive words or phrases associated with it, such as a plural name or a short or long description. An MdmObject
can also have one or more classifications. Classifications are assigned and handled by an application.
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 . |
void |
addDescription(MdmDescription desc) Adds an MdmDescription to the descriptions that are associated with this MdmObject . |
void |
addObjectClassification(java.lang.String classification) Adds a classification to the MdmObject . |
MdmDescription |
findOrCreateDescription(MdmDescriptionType type, java.lang.String language) Gets the MdmDescription of the specified type and language, if it exists. |
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. |
java.util.List |
getDescriptions() Gets the MdmDescription objects that are associated with this MdmObject . |
MdmMetadataProvider |
getMetadataProvider() Gets the MdmMetadataProvider for this MdmObject . |
java.lang.String |
getName() Gets the name of this MdmObject . |
java.lang.String |
getNewName() Gets the name of this MdmObject if you have changed the name of the object by using the setName method but you have not committed the root transaction that contains the name change. |
java.util.List |
getObjectClassifications() Gets a list of the classifications of the MdmObject . |
java.lang.String |
getShortDescription() Gets the short description for this MdmObject . |
boolean |
isClassifiedAs(java.lang.String classification) Indicates whether or not the MdmObject has the specified classification. |
void |
removeDescription(MdmDescription desc) Removes an MdmDescription from the descriptions that are associated with this MdmObject . |
void |
removeObjectClassification(java.lang.String classification) Removes a classification from the 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 |
---|
getContainedByObject, 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
- Indicates that the requested metadata object does not exist or is not available to the MdmMetadataProvider
.public MdmMetadataProvider getMetadataProvider()
MdmMetadataProvider
for this MdmObject
.MdmMetadataProvider
for this MdmObject
.public java.lang.String getName() throws oracle.express.mdm.MetadataNotFoundException
MdmObject
.getName
in class BaseMetadataObject
String
that contains the name of this MdmObject
.oracle.express.mdm.MetadataNotFoundException
- Indicates that the requested metadata object does not exist or is not available to the MdmMetadataProvider
.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
- Indicates that the requested metadata object does not exist or is not available to the MdmMetadataProvider
.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
. If the MdmObject
already has a name, the new name does not take effect until the root transaction is committed.name
- A String
that contains a name for this MdmObject
.public final java.lang.String getNewName()
MdmObject
if you have changed the name of the object by using the setName
method but you have not committed the root transaction that contains the name change. If you have not changed the name of this MdmObject
since you last committed the root transaction, this method returns null
.getNewName
in class BaseMetadataObject
MdmObject
, which takes effect after you commit the current root transaction, or null
if you have not specified a new name.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
- Indicates that the requested metadata object does not exist or is not available to the MdmMetadataProvider
.public final java.util.List getObjectClassifications()
MdmObject
.List
of the classifications of the MdmObject
.public final void addObjectClassification(java.lang.String classification)
MdmObject
.classification
- A String
that contains the classification to add to the MdmObject
.public final void removeObjectClassification(java.lang.String classification)
MdmObject
.classification
- A String
that contains the classification to remove from the MdmObject
.public final boolean isClassifiedAs(java.lang.String classification)
MdmObject
has the specified classification.classification
- A String
that contains the classification to compare to that of this MdmObject
.boolean
that is true
if the MdmObject
has the specified classification or false
if it does not.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)
MdmDescription
of the specified type and language, if it exists. Otherwise, creates an MdmDescription
of the specified type and 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.MdmDescription
of specified type and language with the specified value.public final java.util.List getDescriptions()
MdmDescription
objects that are associated with this MdmObject
.List
of the MdmDescription
objects associated with this MdmObject
.public final void addDescription(MdmDescription desc)
MdmDescription
to the descriptions that are associated with this MdmObject
.desc
- The MdmDescription
to add to this MdmObject
.public final void removeDescription(MdmDescription desc)
MdmDescription
from the descriptions that are associated with this MdmObject
.desc
- The MdmDescription
to remove from this MdmObject
.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |