|
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.MdmDimension
oracle.olapi.metadata.mdm.MdmSubDimension
oracle.olapi.metadata.mdm.MdmHierarchy
public abstract class MdmHierarchy
An MdmSubDimension
that represents members of an Oracle OLAP dimension that are organized either hierarchically or nonhierarchically. An MdmHierarchy
is a component of an MdmPrimaryDimension
.
A hierarchical organization is defined by parent-child relationships between the members of the hierarchy. If the parent-child relationships are defined by levels, then the MdmHierarchy
is an MdmLevelHierarchy
, which has a component MdmLevel
object for each level. If the parent-child relationships are defined by values and not by levels, then the MdmHierarchy
is an MdmValueHierarchy
.
A nonhierarchical MdmHierarchy
is one that is not organized by parent-child relationships. It is represented by an MdmLevelHierarchy
that has only one level.
MdmAttribute
objects record the parent-child relationships among the members of an MdmHierarchy
You use the getParentAttribute
and getAncestorsAttribute
methods to get the MdmAttribute
objects that relate parents to children and ancestors to descendents, respectively.
Method Summary | |
---|---|
MdmAttribute |
getAncestorsAttribute() Gets the ancestors attribute for this MdmHierarchy . |
abstract MdmDimensionMemberInfo |
getDefaultMember() Gets the MdmDimensionMemberInfo that is associated with the default member of this MdmHierarchy . |
MdmQueryColumn |
getETDepthColumn() Gets the MdmQueryColumn that represents the depth column of the embedded totals view associated with the MdmHierarchy . |
MdmQueryColumn |
getETParentColumn() Gets the MdmQueryColumn that represents the parent column of the embedded totals view associated with the MdmHierarchy . |
java.lang.String |
getETViewName() Gets the name of the ET (Embedded Totals) view associated with the MdmHierarchy/CODE>. |
MdmAttribute |
getParentAttribute() Gets the parent attribute for this MdmHierarchy . |
MdmPrimaryDimension |
getPrimaryDimension() Gets the MdmPrimaryDimension of which this MdmHierarchy is a component. |
Query |
getQuery() Gets the Query that is associated with the MdmHierarchy . |
MdmQueryColumn |
getQueryColumn(java.lang.String name) Gets the specified MdmQueryColumn . |
java.util.List<MdmQueryColumn> |
getQueryColumns() Gets the MdmQueryColumn objects that are associated with the MdmHierarchy/CODE>. |
java.lang.String |
getQueryName() Gets the identifier of the MdmHierarchy . |
boolean |
isDefaultHierarchy() Indicates whether this MdmHierarchy is the default component of an MdmPrimaryDimension . |
abstract void |
setDefaultMember(MdmDimensionMemberInfo defaultMember) Specifies a default member for this MdmHierarchy . |
void |
setETViewName(java.lang.String name) Specifies the ET (Embedded Totals) view to associate with the MdmHierarchy/CODE>. |
Methods inherited from class oracle.olapi.metadata.mdm.MdmSubDimension |
---|
addAttribute, getAttributes, removeAttribute |
Methods inherited from class oracle.olapi.metadata.mdm.MdmDimension |
---|
getCardinality, getCustomOrder, getPluralDescription, getShortPluralDescription, setCardinality, setCustomOrder, setPluralDescription, setShortPluralDescription |
Methods inherited from class oracle.olapi.metadata.mdm.MdmSource |
---|
getDataType, getModel, getSource, getSourceMap, getType, setModel |
Methods inherited from class oracle.olapi.metadata.mdm.MdmObject |
---|
acceptVisitor, 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 MdmAttribute getAncestorsAttribute() throws oracle.express.mdm.MetadataNotFoundException
MdmHierarchy
. The ancestors attribute relates each member of this MdmHierarchy
to the members that are the ancestors of it in the hierarchy. For example, the ancestors for a given day in a time hierarchy might be month, quarter, and year. MdmAttribute
that is the ancestors attribute of this MdmHierarchy
.oracle.express.mdm.MetadataNotFoundException
public MdmAttribute getParentAttribute() throws oracle.express.mdm.MetadataNotFoundException
MdmHierarchy
. The parent attribute relates each member of this MdmHierarchy
to the parent of it. MdmAttribute
that is the parent attribute of this MdmHierarchy
.oracle.express.mdm.MetadataNotFoundException
public abstract MdmDimensionMemberInfo getDefaultMember() throws oracle.express.mdm.MetadataNotFoundException
MdmDimensionMemberInfo
that is associated with the default member of this MdmHierarchy
. You can get the value of the default member by calling the getLocalValue
or getUniqueValue
method of the MdmDimensionMemberInfo
.MdmDimensionMemberInfo
for the default member of this MdmHierarchy
.oracle.express.mdm.MetadataNotFoundException
public abstract void setDefaultMember(MdmDimensionMemberInfo defaultMember) throws oracle.express.mdm.MetadataNotFoundException, MdmInvalidValueException
MdmHierarchy
.defaultMember
- The MdmDimensionMemberInfo
that is associated with the dimension member that you want as the default member for this MdmHierarchy
.oracle.express.mdm.MetadataNotFoundException
MdmInvalidValueException
public final boolean isDefaultHierarchy()
MdmHierarchy
is the default component of an MdmPrimaryDimension
.true
if this is the default hierarchy and false
if it is not.public final MdmPrimaryDimension getPrimaryDimension()
MdmPrimaryDimension
of which this MdmHierarchy
is a component.getPrimaryDimension
in class MdmSubDimension
MdmPrimaryDimension
for this MdmHierarchy
.public final java.lang.String getETViewName()
MdmHierarchy/CODE>.
Returns:
A
String that contains the name of the ET view associated with the MdmHierarchy/CODE>.
public final void setETViewName(java.lang.String name)
MdmHierarchy/CODE>.
Parameters:
name
- A String
that contains the name of the ET view to associate with the MdmHierarchy/CODE>.
public final MdmQueryColumn getETParentColumn()
MdmQueryColumn
that represents the parent column of the embedded totals view associated with the MdmHierarchy
.MdmQueryColumn
that represents the parent column of the embedded totals view.public final MdmQueryColumn getETDepthColumn()
MdmQueryColumn
that represents the depth column of the embedded totals view associated with the MdmHierarchy
.MdmQueryColumn
that represents the depth column of the embedded totals view.public final Query getQuery()
Query
that is associated with the MdmHierarchy
.getQuery
in interface MdmQuery
Query
associated with the MdmHierarchy
.public final java.lang.String getQueryName()
MdmHierarchy
.getQueryName
in interface MdmQuery
String
that contains the identifier of the MdmHierarchy
object.public java.util.List<MdmQueryColumn> getQueryColumns()
MdmQueryColumn
objects that are associated with the MdmHierarchy/CODE>.
Specified by:
getQueryColumns
in interface MdmQuery
List
of the MdmQueryColumn
objects associated with the MdmHierarchy
.public MdmQueryColumn getQueryColumn(java.lang.String name)
MdmQueryColumn
.getQueryColumn
in interface MdmQuery
name
- A String
that contains the name of an MdmQueryColumn
.MdmQueryColumn
that has the specified name.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |