Skip navigation links

oracle.olapi.metadata.mdm
Class MdmObject

java.lang.Object
oracle.olapi.metadata.BaseMetadataObject
oracle.olapi.metadata.mdm.MdmObject

All Implemented Interfaces:

MetadataObject

Direct Known Subclasses:

MdmAssignment, MdmCustomMember, MdmDimensionality, MdmModel, MdmNamedBuildProcess, MdmSchema, MdmSource

public abstract class MdmObject

extends BaseMetadataObject

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.

See Also:

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

acceptVisitor

public 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.

Parameters:

visitor - An MdmObjectVisitor.

context - An Object.

Returns:

The Object returned by a method of the MdmObjectVisitor.

getDescription

public final java.lang.String getDescription()
                                      throws oracle.express.mdm.MetadataNotFoundException

Gets a descriptive phrase for this MdmObject.

Returns:

A descriptive phrase for this MdmObject.

Throws:

oracle.express.mdm.MetadataNotFoundException

getMetadataProvider

public MdmMetadataProvider getMetadataProvider()

Gets the MdmMetadataProvider for this MdmObject.

Returns:

The MdmMetadataProvider for this MdmObject.

getName

public java.lang.String getName()
                         throws oracle.express.mdm.MetadataNotFoundException

Gets the name of this MdmObject.

Returns:

A String that contains the name of this MdmObject.

Throws:

oracle.express.mdm.MetadataNotFoundException

getShortDescription

public java.lang.String getShortDescription()
                                     throws oracle.express.mdm.MetadataNotFoundException

Gets the short description for this MdmObject. You can use this description for display in a graphical user interface instead of the return value of the getName method.

Returns:

A String containing the short description of this MdmObject.

Throws:

oracle.express.mdm.MetadataNotFoundException

setDescription

public final void setDescription(java.lang.String description)

Specifies a descriptive phrase for this MdmObject.

Parameters:

description - A String that contains a description for this MdmObject.

setName

public void setName(java.lang.String name)

Specifies a name for this MdmObject.

Parameters:

name - A String that contains a name for this MdmObject.

setShortDescription

public void setShortDescription(java.lang.String description)
                         throws oracle.express.mdm.MetadataNotFoundException

Specifies a short description for this MdmObject. You can use this description for display in a graphical user interface instead of the return value of the getName method.

Parameters:

description - A String that contains a short description for this MdmObject.

Throws:

oracle.express.mdm.MetadataNotFoundException

getDescription

public final java.lang.String getDescription(MdmDescriptionType type)

Gets a description of the specified type for this MdmObject in the default language for the current session.

Parameters:

type - An MdmDescriptionType that specifies the type of description, such as name or long description.

Returns:

A String that contains the descriptive value of the MdmDescription associated with the specified MdmDescriptionType.

getDescription

public final java.lang.String getDescription(MdmDescriptionType type,
                                             java.lang.String language)

Gets a description of the specified type for this MdmObject in the specified.language.

Parameters:

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.

Returns:

A String that contains the descriptive value of the MdmDescription associated with the specified MdmDescriptionType.

setDescription

public final 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.

Parameters:

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.

setDescription

public final 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.

Parameters:

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.

findOrCreateDescription

public 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. Otherwise, creates an MdmDescription of the specified type and language with the specified value.

Parameters:

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.

Returns:

An MdmDescription of specified type and language with the specified value.

Skip navigation links