|
Oracle® OLAP Java API Reference 11g Release 1 (11.1) B28128-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public abstract class MdmAttribute
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 |
---|
public MtmAttributeMap getAttributeMap() throws oracle.express.mdm.MetadataNotFoundException
DimensionMap.getAttributeMaps
.oracle.express.mdm.MetadataNotFoundException
public java.lang.Object acceptVisitor(MdmObjectVisitor visitor, java.lang.Object context)
visitMdmAttribute
method of the specified MdmObjectVisitor
and passes that method the MdmAttribute
and the specified context
object.acceptVisitor
in class MdmObject
visitor
- An MdmObjectVisitor
.context
- An Object
.Object
returned by the visitMdmAttribute
method.public final MdmPrimaryDimension getTargetDimension()
MdmPrimaryDimension
associated with the MdmAttribute
.MdmPrimaryDimension
associated with the MdmAttribute
.public final void setTargetDimension(MdmPrimaryDimension input)
MdmPrimaryDimension
to associate with the MdmAttribute
.input
- The MdmPrimaryDimension
to associate with the >MdmAttribute
.public final MdmDescriptionType getDescriptionType()
MdmDescriptionType
associated with the MdmAttribute
.MdmDescriptionType
associated with the MdmAttribute
.public final void setDescriptionType(MdmDescriptionType input)
MdmDescriptionType
to associate with the MdmAttribute
.input
- The MdmDescriptionType
to associate with the >MdmAttribute
.public final boolean isVisibleForAll()
MdmAttribute
is visible for all Hierarchies and Levels contained within its owning MdmPrimaryDimension
.public final void setIsVisibleForAll(boolean input)
MdmAttribute
is visible for all Hierarchies and Levels contained within its owning MdmPrimaryDimension
.input
- Boolean specifying visibilitypublic final void setPrimaryDimension(MdmPrimaryDimension primaryDimension)
MdmPrimaryDimension
to associate with the MdmAttribute
.primaryDimension
- The MdmPrimaryDimension
to associate with the MdmAttribute
.public java.util.List getDimensionality()
List
of the MdmPrimaryDimension
objects associated with the MdmAttribute
.getDimensionality
in class MdmDimensionedObject
List
of the MdmPrimaryDimension
objects associated with the MdmAttribute
.public MdmAttributeModel getAttributeModel()
MdmAttributeModel
associated with the MdmAttribute
.MdmAttributeModel
for the MdmAttribute
.public final MdmModel getModel()
MdmModel
associated with the MdmAttribute
.getModel
in class MdmSource
MdmModel
for the MdmAttribute
.public void setAttributeModel(MdmAttributeModel model)
MdmAttributeModel
to associate with the MdmAttribute
.model
- The MdmAttributeModel
to associate with the MdmAttribute
.public final void setModel(MdmModel model)
MdmModel
to associate with the MdmAttribute
.setModel
in class MdmSource
model
- The MdmModel
to associate with the MdmAttribute
.public final MdmPrimaryDimension getPrimaryDimension()
MdmPrimaryDimension
associated with the MdmAttribute
.MdmPrimaryDimension
associated with the MdmAttribute
.public final MetadataObject getType()
MdmAttribute
.getType
in class MdmSource
MetadataObject
that represents the OLAP Java API data type.public abstract SQLDataType getSQLDataType()
MdmAttribute
.SQLDataType
that represents the SQL data type.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |