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 finds an existing attribute or creates a new one by using the appropriate method of the MdmPrimaryDimension that dimensions it. For example, the findOrCreateBaseAttribute method of an MdmPrimaryDimension gets an existing MdmBaseAttribute or creates a new one. An application can also get attributes of a dimension or level by using methods such as getShortValueDescriptionAttribute of an MdmPrimaryDimension and getLevelAttribute of an 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

MdmDescriptionType	getDescriptionType() Gets the MdmDescriptionType associated with the MdmAttribute.
java.util.List	getDimensionality() Gets a List of the MdmPrimaryDimension objects 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 a column for the MdmAttribute appears in the OLAP (ET) views for all of the hierarchies of the MdmPrimaryDimension that contains the MdmAttribute.
void	setDescriptionType(MdmDescriptionType input) Specifies an MdmDescriptionType to associate with the MdmAttribute.
void	setIsVisibleForAll(boolean input) Specifies whether Oracle OLAP includes a column for the MdmAttribute in the OLAP (ET) views for all of the hierarchies of the MdmPrimaryDimension that contains 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

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

acceptVisitor, addDescription, addObjectClassification, findOrCreateDescription, getDescription, getDescription, getDescription, getDescriptions, getMetadataProvider, getName, getNewName, getObjectClassifications, getShortDescription, isClassifiedAs, removeDescription, removeObjectClassification, setDescription, setDescription, setDescription, setName, setShortDescription

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

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 a column for the MdmAttribute appears in the OLAP (ET) views for all of the hierarchies of the MdmPrimaryDimension that contains the MdmAttribute.

Returns:

A boolean that is true if a column for the attribute appears in the OLAP views for all of the hierarchies of the dimension or false if it does not.

setIsVisibleForAll

public final void setIsVisibleForAll(boolean input)

Specifies whether Oracle OLAP includes a column for the MdmAttribute in the OLAP (ET) views for all of the hierarchies of the MdmPrimaryDimension that contains the MdmAttribute.

Parameters:

input - A boolean that is true to have Oracle OLAP include a column for the attribute in the OLAP view of each of the hierarchies of the dimension or false to not do so.

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

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.