oracle.dss.metadataManager.common
Class MDObject

java.lang.Object
  |
  +--oracle.dss.metadataUtil.PropertyBag
        |
        +--oracle.dss.metadataManager.common.MDObject

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

MDAttribute, MDFolder, MDLevel, MDMeasure, MDMemberMetadata

public class MDObject

extends PropertyBag

A client-side representation of an object in an analytic workspace or in the repository. Subclasses of this class indicate the kind of object that is being represented. An MDObject is analogous to a Context in JNDI.

See Also:

Serialized Form

Constructor Summary

MDObject()
Constructor.

MDObject( mmServices, java.lang.String mdObjName, MDObject parent)
Constructor.

Method Summary

java.lang.String	getClassName() Retrieves the class name of this object.
java.lang.String	getDescription() Retrieves the description of this object.
java.lang.String	getDriverType() Retrieves the type of driver that this object uses.
java.util.Vector	getDriverTypes() Retrieves all of the driver types for this object.
java.lang.String	getLabel() Retrieves the label of this object.
java.lang.String	getLongLabel() Retrieves the long label of this object.
interface	getMetadataManagerServices() Retrieves the MetadataManagerServices in this object.
java.lang.String	getName() Retrieves the name of this object.
java.lang.String	getObjectType() Retrieves the object type of this object.
java.lang.String	getPath() Retrieves the path of this object.
java.lang.String	getShortLabel() Retrieves the short label of this object.
java.lang.String	getSubObjectType() Retrieve subobject type of this object.
java.lang.String	getUniqueID() Retrieves a unique ID for this object.
boolean	nameEquals(MDObject object) Determines if the given MDObject's name is equivalent to this MDObject's name..
int	setClassName(java.lang.String className) Specifies a class name for this object.
int	setDriverType(java.lang.String strDriverType) Specifies the type of driver that this object requires.
int	setMetadataManagerServices( metadataManagerServices) Specifies the MetadataManagerServices for this object.
int	setName(java.lang.String name) Specifies a name for this object.
int	setObjectType(java.lang.String objType) Specifies the object type of this object.
int	setSubObjectType(java.lang.String objType) Specifies the subobject type for this object.
java.lang.String	toString() Generates a String representation of this object.
java.lang.String	toString(java.lang.String strLabelType) Generates a String representation of this object.

Methods inherited from class oracle.dss.metadataUtil.PropertyBag

getIntPropertyValue, getLongPropertyValue, getObjPropertyValue, getPropertyDataType, getStringVectorPropertyValue, getStrPropertyValue, mergePropertyBags, removeProperty, setIntPropertyValue, setIntPropertyValue, setLongPropertyValue, setLongPropertyValue, setObjPropertyValue, setObjPropertyValue, setProperty, setPropertyBag, setStringVectorPropertyValue, setStringVectorPropertyValue, setStrPropertyValue, setStrPropertyValue, size

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MDObject

public MDObject()

Constructor.

MDObject

public MDObject( mmServices,
                java.lang.String mdObjName,
MDObject parent)

Constructor.

Parameters:

mmServices - The MetadataManagerServices that this root folder exists in.

measureName - The name of this measure.

parent - The object that contains this object.

Method Detail

setMetadataManagerServices

public int setMetadataManagerServices( metadataManagerServices)

Specifies the MetadataManagerServices for this object. Before you call this method, this object has a null MetadataManagerServices.

Parameters:

metadataManagerServices - The implementation of MetadataManagerServices for this object.

Returns:

A constant that indicates whether the MetadataManagerServices was successfully set. The valid constants are listed in the See Also section.

See Also:

MDU.SUCCESS, MDU.FAILURE

getMetadataManagerServices

public getMetadataManagerServices()

Retrieves the MetadataManagerServices in this object.

Returns:

The implementation of MetadataManagerServices that this object uses, or null if no MetadataManagerServices implementation has been set for this object.

getUniqueID

public java.lang.String getUniqueID()

Retrieves a unique ID for this object. The ID is based on the type of driver that this object uses.

Returns:

A unique ID for this object.

getPath

public java.lang.String getPath()

Retrieves the path of this object. The path name includes the name of this object. For metadata, the path name is structured as follows:

service_name!workspace_name\root_folder_name\subfolder_name\object_name

For objects in the repository, the path name is structured as follows:

/subfolder/object_name

Returns:

The path of this object.

getDescription

public java.lang.String getDescription()

Retrieves the description of this object. This method returns the value of the Description property of this object.

Returns:

The description of this object.

getDriverTypes

public java.util.Vector getDriverTypes()

Retrieves all of the driver types for this object. A calculation can have more than one kind of driver. Most components that you save will have only one.

Returns:

The driver types for this object.

getDriverType

public java.lang.String getDriverType()

Retrieves the type of driver that this object uses.

Returns:

The type of driver for this object.

setDriverType

public int setDriverType(java.lang.String strDriverType)

Specifies the type of driver that this object requires.

Parameters:

strDriverType - The type of driver. For components, pass MDU.PERSISTENCE_DRIVER.

Returns:

A constant that indicates whether the driver was successfully set. Valid constants are listed in the See Also section.

See Also:

MDU.SUCCESS, MDU.FAILURE, MDU.PERSISTENCE_DRIVER, MDU.MDM_DRIVER

nameEquals

public boolean nameEquals(MDObject object)

Determines if the given MDObject's name is equivalent to this MDObject's name..

Returns:

true if specified MDObject's name is equivalent false if specified MDObject's name is not equivalent

getShortLabel

public java.lang.String getShortLabel()

Retrieves the short label of this object.

Returns:

The short label of this object.

getLongLabel

public java.lang.String getLongLabel()

Retrieves the long label of this object.

Returns:

The long label of this object.

toString

public java.lang.String toString()

Generates a String representation of this object. This method returns the long label of this object.

Overrides:

toString in class java.lang.Object

Returns:

The long label of this object.

toString

public java.lang.String toString(java.lang.String strLabelType)

Generates a String representation of this object. This method returns the specified label.

Parameters:

strLabelType - A constant that identifies the type of label that you want. Valid constants are listed in the See Also section.

Returns:

The requested label, or null if strLabelType is not a valid label type.

See Also:

MM.UNIQUE_ID, MM.OLAPI_METADATA_ID, MM.SHORT_LABEL, MM.MEDIUM_LABEL, MM.LONG_LABEL, MM.DESCRIPTION, MDU.OBJECT_NAME

getName

public java.lang.String getName()

Retrieves the name of this object.

Returns:

The name of this mdObject, or null if no name has been set.

setName

public int setName(java.lang.String name)

Specifies a name for this object.

Returns:

A constant that indicates whether the name was successfully set. Valid constants are listed in the See Also section.

See Also:

MDU.SUCCESS, MDU.FAILURE

getLabel

public java.lang.String getLabel()

Retrieves the label of this object.

Returns:

The label of this mdObject, or null if no label has been set.

getClassName

public java.lang.String getClassName()

Retrieves the class name of this object.

Returns:

The class name for this object, or null if no class name has been set for this object.

setClassName

public int setClassName(java.lang.String className)

Specifies a class name for this object.

Returns:

A constant that indicates whether the class name was successfully set. Valid constants are listed in the See Also section.

See Also:

MDU.SUCCESS, MDU.FAILURE

getObjectType

public java.lang.String getObjectType()

Retrieves the object type of this object.

Returns:

The type of this object, or null if no object type has been set.

setObjectType

public int setObjectType(java.lang.String objType)

Specifies the object type of this object.

Returns:

A constant that indicates whether the object type was successfully set. Valid constants are listed in the See Also section.

See Also:

MDU.SUCCESS, MDU.FAILURE

getSubObjectType

public java.lang.String getSubObjectType()

Retrieve subobject type of this object.

Returns:

The subobject type of this object, or null if no subobject type has been set for this object.

setSubObjectType

public int setSubObjectType(java.lang.String objType)

Specifies the subobject type for this object.

Parameters:

name - The subobject type of this object.

Returns:

A constant that indicates whether the subobject type was successfully set. Valid constants are listed in the See Also section.

See Also:

MDU.SUCCESS, MDU.FAILURE