oracle.dss.metadataManager.common
Class MDAttribute

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

All Implemented Interfaces:

java.io.Serializable

public class MDAttribute

extends MDObject

A client-side representation of an attribute in an analytic workspace. An MDAttribute provides, to a java client, information about an attribute in the workspace.

An attribute is a characteristic of a dimension. For example, a Product dimension might have a Color attribute. This would allow a search for blue products, for example.

See Also:

Serialized Form

Constructor Summary

MDAttribute()
Constructor.

Method Summary

MDDimension	getDomainDimension() Retrieves the domain dimension of this attribute.
MDLevel[]	getLevels() Retrieves the levels to which this attribute applies.
MDMemberMetadata	getMemberLongLabelMetadata() Retrieves long labels for the members of this attribute.
MDMemberMetadata	getMemberShortLabelMetadata() Retrieves the short labels for the members of this attribute.
MDDimension[]	getQualifyingDimensions() Retrieves the qualifying dimensions for this attribute.
MDDimension	getRangeDimension() Retrieves the range dimension for this attribute.

Methods inherited from class oracle.dss.metadataManager.common.MDObject

getClassName, getDescription, getDriverType, getDriverTypes, getLabel, getLongLabel, getMetadataManagerServices, getName, getObjectType, getPath, getShortLabel, getSubObjectType, getUniqueID, nameEquals, setClassName, setDriverType, setMetadataManagerServices, setName, setObjectType, setSubObjectType, toString, toString

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

MDAttribute

public MDAttribute()

Constructor. Application developers should never construct an MDAttribute. Attributes are actually defined in the analytic workspace on the server. You cannot use the MetadataManager to create attributes in the workspace.

To find the MDAttribute that you want, call the getAttribute or getAttributes method of another object. For example, to retrieve the attributes of a dimension, call the Dimension.getAttributes method. To find the attributes that have a particular property value, MetadataManagerServices.getAttribute.

See Also:

MDDimension.getAttributes()

Method Detail

getDomainDimension

public MDDimension getDomainDimension()
                               throws MetadataManagerException

Retrieves the domain dimension of this attribute. The domain dimension is the dimension that this attribute describes. For example, if this attribute is a color attribute for products, Then the domain dimension is the Product dimension.

Returns:

The domain dimension.

Throws:

MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

getRangeDimension

public MDDimension getRangeDimension()
                              throws MetadataManagerException

Retrieves the range dimension for this attribute. The range dimension is the dimension that defines the values for this attribute. For example, if this attribute defines color, the range dimension defines the possible color values.

Returns:

The range dimension.

Throws:

MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

getQualifyingDimensions

public MDDimension[] getQualifyingDimensions()
                                      throws MetadataManagerException

Retrieves the qualifying dimensions for this attribute. Qualifying dimensions are dimensions that the attribute uses, other than the range and domain dimensions. For example, if this attribute defines territories for salespersons, and those territories vary over time, then the Time dimension would be a qualifying dimension.

Returns:

The qualifying dimensions for this attribute.

Throws:

MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

getLevels

public MDLevel[] getLevels()
                    throws MetadataManagerException

Retrieves the levels to which this attribute applies. Attributes can apply to all levels of a hierarchy or only to some levels. For example, an attribute might describe the day of the week, with values of Sunday, Monday, Tuesday, and so on. In a Time dimension, this attribute would apply only to the Day level.

Returns:

The levels of this attribute.

Throws:

MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

getMemberShortLabelMetadata

public MDMemberMetadata getMemberShortLabelMetadata()
                                             throws MetadataManagerException

Retrieves the short labels for the members of this attribute.

Returns:

The short labels.

Throws:

MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

getMemberLongLabelMetadata

public MDMemberMetadata getMemberLongLabelMetadata()
                                            throws MetadataManagerException

Retrieves long labels for the members of this attribute.

Returns:

The long labels.

Throws:

MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.