Skip navigation links

oracle.olapi.metadata.mdm
Class MdmAttribute

java.lang.Object
oracle.olapi.metadata.BaseMetadataObject
oracle.olapi.metadata.mdm.MdmObject
oracle.olapi.metadata.mdm.MdmSource
oracle.olapi.metadata.mdm.MdmDimensionedObject
oracle.olapi.metadata.mdm.MdmAttribute

All Implemented Interfaces:

MetadataObject

Direct Known Subclasses:

MdmMultiValuedAttribute, MdmSingleValuedAttribute

public abstract class MdmAttribute

extends MdmDimensionedObject

The abstract base class for an MdmDimensionedObject that represents one or more characteristic of the members of an MdmDimension. An MdmAttribute relates one member of the MdmDimension to one or more values. For example, the end date MdmAttribute of an MdmTimeDimension relates an end date to each member of an MdmTimeDimension. The data type of an MdmAttribute can be any of the OLAP Java API data types. A value of MdmAttribute can be a boolean, a Date, a number, a String, an MdmSource, or other kinds of objects.

An MdmAttribute is an MdmDimensionedObject because it has elements that are organized by an MdmDimension. For example, the end date MdmAttribute has one element (with a value that specifies a date) for each member of the MdmTimeDimension associated with it. An application creates an MdmAttribute with a createAttribute method of the MdmDimension object that dimensions it.

Some attributes relate to all of the members of a dimension. You get such an attribute by calling the getAttributes method of the MdmDimension concrete subclass. Other attributes apply only to specific subclasses, such as the level attribute of an MdmLevelHierarchy, which you get with the getLevelAttribute method of the MdmLevelHierarchy.

Sometimes, not all of the members of an MdmDimension relate to the values of an MdmAttribute. For example, an MdmLevelHierarchy that represents a dimension of product items might have an attribute at the lowest level that relates a color to the items. The color attribute does not apply to members at higher levels of the hierarchy. If an MdmAttribute does not apply to a member of an MdmDimension, then the attribute value for that member is null.

Some MdmAttribute objects provide a relation that is one-to-many, rather than one-to-one. Therefore, a member in an MdmDimension might map to a whole set of MdmAttribute elements. For example, the MdmAttribute that is the ancestors attribute of an MdmHierarchy relates each member of the MdmHierarchy to the set of the MdmHierarchy members that are the ancestors of it.

Method Summary

java.lang.Object	acceptVisitor(MdmObjectVisitor visitor, java.lang.Object context) Calls the visitMdmAttribute method of the specified MdmObjectVisitor and passes that method the MdmAttribute and the specified context object.
MtmAttributeMap	getAttributeMap() Deprecated. As of Oracle 11g, Release 1 (11.1); replaced by DimensionMap.getAttributeMaps.
MdmAttributeModel	getAttributeModel() Gets the MdmAttributeModel associated with the MdmAttribute.
MdmDescriptionType	getDescriptionType() Gets the MdmDescriptionType associated with the MdmAttribute.
java.util.List	getDimensionality() Gets a List of the MdmPrimaryDimension objects associated with the MdmAttribute.
MdmModel	getModel() Gets the MdmModel associated with the MdmAttribute.
MdmPrimaryDimension	getPrimaryDimension() Gets the MdmPrimaryDimension associated with the MdmAttribute.
abstract SQLDataType	getSQLDataType() Gets the SQL data type for the MdmAttribute.
MdmPrimaryDimension	getTargetDimension() Gets the MdmPrimaryDimension associated with the MdmAttribute.
MetadataObject	getType() Gets the OLAP Java API data type for the MdmAttribute.
boolean	isVisibleForAll() Indicates whether the MdmAttribute is visible for all Hierarchies and Levels contained within its owning MdmPrimaryDimension.
void	setAttributeModel(MdmAttributeModel model) Specifies an MdmAttributeModel to associate with the MdmAttribute.
void	setDescriptionType(MdmDescriptionType input) Specifies an MdmDescriptionType to associate with the MdmAttribute.
void	setIsVisibleForAll(boolean input) Specifies whether the MdmAttribute is visible for all Hierarchies and Levels contained within its owning MdmPrimaryDimension.
void	setModel(MdmModel model) Specifies an MdmModel to associate with the MdmAttribute.
void	setPrimaryDimension(MdmPrimaryDimension primaryDimension) Specifies the MdmPrimaryDimension to associate with the MdmAttribute.
void	setTargetDimension(MdmPrimaryDimension input) Specifies an MdmPrimaryDimension to associate with the MdmAttribute.

Methods inherited from class oracle.olapi.metadata.mdm.MdmDimensionedObject

addDimension, addDimensionality, getDimensions, isBooleanValued, removeDimensionality, setBooleanValued

Methods inherited from class oracle.olapi.metadata.mdm.MdmSource

getDataType, getSource, getSourceMap

Methods inherited from class oracle.olapi.metadata.mdm.MdmObject

findOrCreateDescription, getDescription, getDescription, getDescription, getMetadataProvider, getName, getShortDescription, setDescription, setDescription, setDescription, setName, setShortDescription

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

getAttributeMap

public MtmAttributeMap getAttributeMap()
                                throws oracle.express.mdm.MetadataNotFoundException

Deprecated. As of Oracle 11g, Release 1 (11.1); replaced by DimensionMap.getAttributeMaps.

Throws:

oracle.express.mdm.MetadataNotFoundException

acceptVisitor

public java.lang.Object acceptVisitor(MdmObjectVisitor visitor,
                                      java.lang.Object context)

Calls the visitMdmAttribute method of the specified MdmObjectVisitor and passes that method the MdmAttribute and the specified context object.

Specified by:

acceptVisitor in class MdmObject

Parameters:

visitor - An MdmObjectVisitor.

context - An Object.

Returns:

The Object returned by the visitMdmAttribute method.

getTargetDimension

public final MdmPrimaryDimension getTargetDimension()

Gets the MdmPrimaryDimension associated with the MdmAttribute.

Returns:

The MdmPrimaryDimension associated with the MdmAttribute.

setTargetDimension

public final void setTargetDimension(MdmPrimaryDimension input)

Specifies an MdmPrimaryDimension to associate with the MdmAttribute.

Parameters:

input - The MdmPrimaryDimension to associate with the >MdmAttribute.

getDescriptionType

public final MdmDescriptionType getDescriptionType()

Gets the MdmDescriptionType associated with the MdmAttribute.

Returns:

The MdmDescriptionType associated with the MdmAttribute.

setDescriptionType

public final void setDescriptionType(MdmDescriptionType input)

Specifies an MdmDescriptionType to associate with the MdmAttribute.

Parameters:

input - The MdmDescriptionType to associate with the >MdmAttribute.

isVisibleForAll

public final boolean isVisibleForAll()

Indicates whether the MdmAttribute is visible for all Hierarchies and Levels contained within its owning MdmPrimaryDimension.

Returns:

Boolean indicating visibility

setIsVisibleForAll

public final void setIsVisibleForAll(boolean input)

Specifies whether the MdmAttribute is visible for all Hierarchies and Levels contained within its owning MdmPrimaryDimension.

Parameters:

input - Boolean specifying visibility

setPrimaryDimension

public final void setPrimaryDimension(MdmPrimaryDimension primaryDimension)

Specifies the MdmPrimaryDimension to associate with the MdmAttribute.

Parameters:

primaryDimension - The MdmPrimaryDimension to associate with the MdmAttribute.

getDimensionality

public java.util.List getDimensionality()

Gets a List of the MdmPrimaryDimension objects associated with the MdmAttribute.

Overrides:

getDimensionality in class MdmDimensionedObject

Returns:

A List of the MdmPrimaryDimension objects associated with the MdmAttribute.

getAttributeModel

public MdmAttributeModel getAttributeModel()

Gets the MdmAttributeModel associated with the MdmAttribute.

Returns:

The MdmAttributeModel for the MdmAttribute.

getModel

public final MdmModel getModel()

Gets the MdmModel associated with the MdmAttribute.

Overrides:

getModel in class MdmSource

Returns:

The MdmModel for the MdmAttribute.

setAttributeModel

public void setAttributeModel(MdmAttributeModel model)

Specifies an MdmAttributeModel to associate with the MdmAttribute.

Parameters:

model - The MdmAttributeModel to associate with the MdmAttribute.

setModel

public final void setModel(MdmModel model)

Specifies an MdmModel to associate with the MdmAttribute.

Overrides:

setModel in class MdmSource

Parameters:

model - The MdmModel to associate with the MdmAttribute.

getPrimaryDimension

public final MdmPrimaryDimension getPrimaryDimension()

Gets the MdmPrimaryDimension associated with the MdmAttribute.

Returns:

The MdmPrimaryDimension associated with the MdmAttribute.

getType

public final MetadataObject getType()

Gets the OLAP Java API data type for the MdmAttribute.

Specified by:

getType in class MdmSource

Returns:

A MetadataObject that represents the OLAP Java API data type.

getSQLDataType

public abstract SQLDataType getSQLDataType()

Gets the SQL data type for the MdmAttribute.

Returns:

A SQLDataType that represents the SQL data type.

Skip navigation links