|
Oracle® OLAP Analytic Workspace Java API Reference 10g Release 2 (10.2.0.3) B14351-03 Beta Draft |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectoracle.AWXML.BaseObject
oracle.AWXML.AWObject
oracle.AWXML.Hierarchy
public class Hierarchy
An AWObject that specifies a hierarchy of a dimension.
A hierarchy defines an ordered set of relationships
between dimension members.
A Hierarchy can be level-based or value-based.
A level-based Hierarchy has associated Level
objects and an ordered list of HierarchyLevelAssociation objects
that specify the order of the Level objects in the
Hierarchy.
The first level is the most aggregate and the last level is the least
aggregate.
A Hierarchy implements the DerivedMeasureInput
interface.
You can therefore use it as input to the calculations for a
DerivedMeasure.
| Field Summary |
|---|
| Fields inherited from class oracle.AWXML.BaseObject |
|---|
DATABASENULL |
| Constructor Summary | |
|---|---|
Hierarchy(BaseObject input)
Creates a Hierarchy for the specified Dimension. |
|
| Method Summary | |
|---|---|
void |
addHierarchyLevelAssociation(HierarchyLevelAssociation input)
Adds the specified HierarchyLevelAssociation to the end of the
list of HierarchyLevelAssociation objects of the
Hierarchy. |
void |
addHierarchyLevelAssociationAfter(HierarchyLevelAssociation input,
BaseObject reference)
Adds the specified HierarchyLevelAssociation after the
referenced HierarchyLevelAssociation in the list of
HierarchyLevelAssociation objects of the
Hierarchy. |
void |
addHierarchyLevelAssociationBefore(HierarchyLevelAssociation input,
BaseObject reference)
Adds the specified HierarchyLevelAssociation before the
referenced HierarchyLevelAssociation in the list of
HierarchyLevelAssociation objects of the
Hierarchy. |
void |
addHierarchyLevelAssociationFirst(HierarchyLevelAssociation input)
Adds the specified HierarchyLevelAssociation to the beginning
of the list of HierarchyLevelAssociation objects of the
Hierarchy. |
java.lang.String |
Alter(AWConnection connection)
Alters the Hierarchy in the current analytic workspace
of the specified database connection. |
java.lang.String |
Create(AWConnection connection)
Creates a Hierarchy in the current analytic workspace
of the specified connection. |
HierarchyLevelAssociation |
createHierarchyLevelAssociation()
Creates a HierarchyLevelAssociation and adds it to the end of
the list of HierarchyLevelAssociation objects of the
Hierarchy. |
HierarchyLevelAssociation |
createHierarchyLevelAssociationAfter(HierarchyLevelAssociation input)
Creates a HierarchyLevelAssociation and adds it after the
specified HierarchyLevelAssociation to the
the list of HierarchyLevelAssociation objects of the
Hierarchy. |
HierarchyLevelAssociation |
createHierarchyLevelAssociationBefore(HierarchyLevelAssociation input)
Creates a HierarchyLevelAssociation and adds it before the
specified HierarchyLevelAssociation to the
the list of HierarchyLevelAssociation objects of the
Hierarchy. |
HierarchyLevelAssociation |
createHierarchyLevelAssociationFirst()
Creates a HierarchyLevelAssociation and adds it to the
beginning of the list of HierarchyLevelAssociation objects of
the Hierarchy. |
java.lang.String |
Delete(AWConnection connection)
Deletes the Hierarchy in the current analytic workspace
of the specified database connection. |
AttributeProjection |
findAttributeProjection(Attribute input)
Gets the specified AttributeProjection from the list of
Attribute objects owned by the Hierarchy. |
Attribute |
getDefaultOrder()
Gets the Attribute that specifies the ordering of the
Hierarchy members. |
java.util.Vector |
getHierarchyLevels()
Gets the list of the HierarchyLevelAssociation objects of the
Hierarchy. |
boolean |
getIsDefault()
Indicates whether the Hierarchy is the default hierarchy for
the associated Dimension. |
java.lang.String |
getType()
Gets the type of the Hierarchy, which is LEVEL
for a level-based hierarchy or VALUE for a value-based
hierarchy. |
void |
removeHierarchyLevelAssociation(HierarchyLevelAssociation input)
Removes the specified HierarchyLevelAssociation from the
Hierarchy. |
void |
setDefaultOrder(Attribute input)
Specifies an Attribute that defines the order of the members
of the Hierarchy. |
void |
setIsDefault(boolean input)
Specifies whether the Hierarchy is the default hierarchy for
the associated Dimension. |
void |
setIsDefault(java.lang.Boolean input)
Specifies whether the Hierarchy is the default hierarchy for
the associated Dimension. |
void |
setType(java.lang.String input)
Specifies the type of the Hierarchy, which is
LEVEL for a level-based hierarchy or VALUE for a
value-based hierarchy. |
java.lang.String |
WriteToXML()
Gets an XML representation of the Hierarchy. |
| Methods inherited from class oracle.AWXML.BaseObject |
|---|
CreateAfter, CreateBefore, CreateFirst, DataRead, getColumnName, getId, getLongName, getLongName, getName, getOwner, getPluralName, getPluralName, getSchema, getShortName, getShortName, setColumnName, setLongName, setLongName, setName, setPluralName, setPluralName, setSchema, setShortName, setShortName |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public Hierarchy(BaseObject input)
Hierarchy for the specified Dimension.
An application should use the createHierarchy method of a
Dimension to create a Hierarchy.
input - The BaseObject to own the Hierarchy.| Method Detail |
|---|
public java.lang.String WriteToXML()
Hierarchy.
WriteToXML in class AWObjectString that represents the
Hierarchy.public void setDefaultOrder(Attribute input)
Attribute that defines the order of the members
of the Hierarchy.
input - The Attribute that defineS the order
of the members of the Hierarchy.public Attribute getDefaultOrder()
Attribute that specifies the ordering of the
Hierarchy members.
Attribute that specifies the ordering of the
Hierarchy members.public void setIsDefault(java.lang.Boolean input)
Hierarchy is the default hierarchy for
the associated Dimension.
input - A Boolean that contains true if you
want the Hierarchy to be the default or
false otherwise.public void setIsDefault(boolean input)
Hierarchy is the default hierarchy for
the associated Dimension.
input - A boolean that is true if you
want the Hierarchy to be the default or
false otherwise.public boolean getIsDefault()
Hierarchy is the default hierarchy for
the associated Dimension.
boolean that is true if the
Hierarchy is the default or false
if it is not.public void addHierarchyLevelAssociation(HierarchyLevelAssociation input)
HierarchyLevelAssociation to the end of the
list of HierarchyLevelAssociation objects of the
Hierarchy.
The Level associated with the specified
HierarchyLevelAssociation is therefore identified as the
lowest, least aggregate, Level.
input - The HierarchyLevelAssociation to add to the
Hierarchy.
public void addHierarchyLevelAssociationAfter(HierarchyLevelAssociation input,
BaseObject reference)
HierarchyLevelAssociation after the
referenced HierarchyLevelAssociation in the list of
HierarchyLevelAssociation objects of the
Hierarchy.
input - The HierarchyLevelAssociation to add to the
Hierarchy.reference - The HierarchyLevelAssociation after which
to add the specified
HierarchyLevelAssociation.
public void addHierarchyLevelAssociationBefore(HierarchyLevelAssociation input,
BaseObject reference)
HierarchyLevelAssociation before the
referenced HierarchyLevelAssociation in the list of
HierarchyLevelAssociation objects of the
Hierarchy.
input - The HierarchyLevelAssociation to add to the
Hierarchy.reference - The HierarchyLevelAssociation before which
to add the specified
HierarchyLevelAssociation.public void addHierarchyLevelAssociationFirst(HierarchyLevelAssociation input)
HierarchyLevelAssociation to the beginning
of the list of HierarchyLevelAssociation objects of the
Hierarchy.
The Level associated with the specified
HierarchyLevelAssociation is therefore identified as the
highest, most aggregate, Level.
input - The HierarchyLevelAssociation to add to the
Hierarchy.public void removeHierarchyLevelAssociation(HierarchyLevelAssociation input)
HierarchyLevelAssociation from the
Hierarchy.
input - The HierarchyLevelAssociation to remove from the
Hierarchy.public java.util.Vector getHierarchyLevels()
HierarchyLevelAssociation objects of the
Hierarchy.
Vector that contains the list of the
HierarchyLevelAssociation objects of the
Hierarchy.public HierarchyLevelAssociation createHierarchyLevelAssociation()
HierarchyLevelAssociation and adds it to the end of
the list of HierarchyLevelAssociation objects of the
Hierarchy.
The Level associated with the new
HierarchyLevelAssociation is therefore identified as the
lowest, least aggregate, Level.
HierarchyLevelAssociation.public java.lang.String getType()
Hierarchy, which is LEVEL
for a level-based hierarchy or VALUE for a value-based
hierarchy.
String that contains LEVEL for a
level-based hierarchy or VALUE for a value-based
hierarchy.public void setType(java.lang.String input)
Hierarchy, which is
LEVEL for a level-based hierarchy or VALUE for a
value-based hierarchy.
By default, a Hierarchy is level-based.
input - A String that contains LEVEL for a
level-based hierarchy or VALUE for a value-based
hierarchy.public HierarchyLevelAssociation createHierarchyLevelAssociationAfter(HierarchyLevelAssociation input)
HierarchyLevelAssociation and adds it after the
specified HierarchyLevelAssociation to the
the list of HierarchyLevelAssociation objects of the
Hierarchy.
input - The HierarchyLevelAssociation after which to add
the new HierarchyLevelAssociation.
HierarchyLevelAssociation object.public HierarchyLevelAssociation createHierarchyLevelAssociationBefore(HierarchyLevelAssociation input)
HierarchyLevelAssociation and adds it before the
specified HierarchyLevelAssociation to the
the list of HierarchyLevelAssociation objects of the
Hierarchy.
input - The HierarchyLevelAssociation before which to add
the new HierarchyLevelAssociation.
HierarchyLevelAssociation object.public HierarchyLevelAssociation createHierarchyLevelAssociationFirst()
HierarchyLevelAssociation and adds it to the
beginning of the list of HierarchyLevelAssociation objects of
the Hierarchy.
The Level associated with the new
HierarchyLevelAssociation is therefore identified as the
highest, most aggregate, Level.
HierarchyLevelAssociation.public java.lang.String Create(AWConnection connection)
Hierarchy in the current analytic workspace
of the specified connection.
Create in class BaseObjectconnection - The AWConnection that specifies the
connection.
String that contains success if this
method successfully creates the Hierarchy.public java.lang.String Alter(AWConnection connection)
Hierarchy in the current analytic workspace
of the specified database connection.
Alter in class BaseObjectconnection - The AWConnection that specifies the
database connection.
String that contains success if this
method successfully alters the Hierarchy.public java.lang.String Delete(AWConnection connection)
Hierarchy in the current analytic workspace
of the specified database connection.
Delete in class BaseObjectconnection - The AWConnection that specifies the
database connection.
String if this method successfully
deletes the Hierarchy.public AttributeProjection findAttributeProjection(Attribute input)
AttributeProjection from the list of
Attribute objects owned by the Hierarchy.
input - The AttributeProjection that you want to find.
AttributeProjection that you want to find if it
is in the list of Attribute objects owned by the
Hierarchy
|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||