oracle.AWXML
Class Hierarchy

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.AWObject
              |
              +--oracle.AWXML.Hierarchy

public class Hierarchy

extends AWObject

implements DerivedMeasureInput

A model object that defines the basic characteristics of a hierarchy. A Hierarchy is an AWObject that defines a hierarchical relationship between a set of levels in a dimension.

Hierarchies implement the DerivedMeasureInput interface, and therefore can be used as input to the calculations that define a derived measure.

Methods for setting the logical name, and other text identifiers are inherited from BaseObject. Methods for applying attributes and defining a mapping to the data source are inherited from AWObject.

Hierarchy

public Hierarchy(BaseObject input)

Creates a new Hierarchy for the specified Dimension.

Note: The object factories are a recommended way of creating objects. For example, use the createHierarchy method on a Dimension object.

Parameters:

input - A BaseObject representing the parent dimension Constructor for a Hierarchy. For the specified BaseObject, creates the hierarchy's AWObject parent.

input - BaseObject

WriteToXML

public java.lang.String WriteToXML()

Returns the Hierarchy object as an XML string.

Overrides:

WriteToXML in class AWObject

Returns:

A String containing the XML that represents the Hierarchy.

setDefaultOrder

public void setDefaultOrder(Attribute input)

Sets an Attribute to specifies how the dimension members are ordered. For example, in a parent-child hierarchy, the attribute would specify the parent of each of the dimension members in the hierarchy.

Parameters:

input - Attribute

getDefaultOrder

public Attribute getDefaultOrder()

Returns an Attribute that specifies how the dimension members are ordered. For example, in a parent-child hierarchy, the attribute would specify the parent of each of the dimension members in the hierarchy.

Returns:

Attribute

setIsDefault

public void setIsDefault(java.lang.Boolean input)

Specifies whether or not the Hierarchy is the default hierarchy for the dimension.

Parameters:

input - Boolean. YES makes the hierarchy the default

setIsDefault

public void setIsDefault(boolean input)

Specifies whether or not the Hierarchy is the default hierarchy for the dimension.

Parameters:

input - boolean. YES makes the hierarchy the default

getIsDefault

public boolean getIsDefault()

Returns a boolean indicating whether or not the Hierarchy is the default hierarchy for the dimension.

Returns:

boolean, YES means that the hierarchy is the default

addHierarchyLevelAssociation

public void addHierarchyLevelAssociation(HierarchyLevelAssociation input)

Adds a HierarchyLevelAssociation to the Hierarchy. A HierarchyLevelAssociation associates a level with a hierarchy. The ordered list of HierarchyLevelAssociations specifies the order of the levels in the hierarchy. The first level is the most aggregate. The last level is the least aggregate.

Parameters:

input - The HierarchyLevelAssociation to add to the hierarchy

addHierarchyLevelAssociationAfter

public void addHierarchyLevelAssociationAfter(HierarchyLevelAssociation input,
BaseObject reference)

Adds a HierarchyLevelAssociation to an ordered list of HierarchyLevelAssociation objects. Adds the new object after the specified object.

A HierarchyLevelAssociation associates a level with a hierarchy. The ordered list of HierarchyLevelAssociations specifies the order of the levels in the hierarchy. The first level is the most aggregate. The last level is the least aggregate.

Parameters:

input - The HierarchyLevelAssociation to add to the hierarchy

reference - The BaseObject after which the new object should be added

addHierarchyLevelAssociationBefore

public void addHierarchyLevelAssociationBefore(HierarchyLevelAssociation input,
BaseObject reference)

Adds a HierarchyLevelAssociation to an ordered list of HierarchyLevelAssociation objects. Adds the new object before the specified object.

A HierarchyLevelAssociation associates a level with a hierarchy. The ordered list of HierarchyLevelAssociations specifies the order of the levels in the hierarchy. The first level is the most aggregate. The last level is the least aggregate.

Parameters:

input - The HierarchyLevelAssociation to add to the hierarchy

reference - The BaseObject before which the new object should be added

addHierarchyLevelAssociationFirst

public void addHierarchyLevelAssociationFirst(HierarchyLevelAssociation input)

Adds a HierarchyLevelAssociation to an ordered list of HierarchyLevelAssociation objects. Makes the new object the first object in the list.

A HierarchyLevelAssociation associates a level with a hierarchy. The ordered list of HierarchyLevelAssociations specifies the order of the levels in the hierarchy. The first level is the most aggregate. The last level is the least aggregate.

Parameters:

input - The HierarchyLevelAssociation to add as the top level of the hierarchy

removeHierarchyLevelAssociation

public void removeHierarchyLevelAssociation(HierarchyLevelAssociation input)

Removes a HierarchyLevelAssociation from the Hierarchy. A HierarchyLevelAssociation associates a level with a hierarchy. The ordered list of HierarchyLevelAssociations specifies the order of the levels in the hierarchy. The first level is the most aggregate. The last level is the least aggregate.

Parameters:

input - The HierarchyLevelAssociation to remove from the hierarchy

getHierarchyLevels

public java.util.Vector getHierarchyLevels()

Returns the list of levels in the Hierarchy

Returns:

A Vector containing the list of Level objects

createHierarchyLevelAssociation

public HierarchyLevelAssociation createHierarchyLevelAssociation()

Creates a HierarchyLevelAssociation for the Hierarchy.

A HierarchyLevelAssociation associates a level with a hierarchy. The ordered list of HierarchyLevelAssociations specifies the order of the levels in the hierarchy. The first level is the most aggregate. The last level is the least aggregate.

Returns:

The new HierarchyLevelAssociation for the hierarchy

createHierarchyLevelAssociationAfter

public HierarchyLevelAssociation createHierarchyLevelAssociationAfter(HierarchyLevelAssociation input)

Creates a new HierarchyLevelAssociation for the Hierarchy. Adds the new HierarchyLevelAssociation to an ordered list of HierarchyLevelAssociation objects. Adds the new object after the specified object.

A HierarchyLevelAssociation associates a level with a hierarchy. The ordered list of HierarchyLevelAssociations specifies the order of the levels in the hierarchy. The first level is the most aggregate. The last level is the least aggregate.

Parameters:

input - The existing HierarchyLevelAssociation object, after which the new HierarchyLevelAssociation object should be created

Returns:

The new HierarchyLevelAssociation object

createHierarchyLevelAssociationBefore

public HierarchyLevelAssociation createHierarchyLevelAssociationBefore(HierarchyLevelAssociation input)

Creates a new HierarchyLevelAssociation for the Hierarchy. Adds the new HierarchyLevelAssociation to an ordered list of HierarchyLevelAssociation objects. Adds the new object before the specified object.

A HierarchyLevelAssociation associates a level with a hierarchy. The ordered list of HierarchyLevelAssociations specifies the order of the levels in the hierarchy. The first level is the most aggregate. The last level is the least aggregate.

Parameters:

input - The existing HierarchyLevelAssociation object, before which the new HierarchyLevelAssociation object should be created

Returns:

The new HierarchyLevelAssociation object

createHierarchyLevelAssociationFirst

public HierarchyLevelAssociation createHierarchyLevelAssociationFirst()

Creates a new HierarchyLevelAssociation for the Hierarchy. Adds the new HierarchyLevelAssociation to an ordered list of HierarchyLevelAssociation objects. Makes the new object the first object in the list.

A HierarchyLevelAssociation associates a level with a hierarchy. The ordered list of HierarchyLevelAssociations specifies the order of the levels in the hierarchy. The first level is the most aggregate. The last level is the least aggregate.

Returns:

The new HierarchyLevelAssociation object

Create

public java.lang.String Create(AWConnection connection)

Creates the Hierarchy within the current analytic workspace of the specified connection.

Overrides:

Create in class BaseObject

Parameters:

connection - An AWConnection that defines the connection.

Returns:

String

Delete

public java.lang.String Delete(AWConnection connection)

Deletes the Hierarchy from the current analytic workspace of the specified connection.

Overrides:

Delete in class BaseObject

Parameters:

connection - An AWConnection that defines the connection.

Returns:

String

findAttributeProjection

public AttributeProjection findAttributeProjection(Attribute input)

Returns the hierarchy attribute (AttributeProjection) that corresponds to the specified dimension attribute (Attribute).

Parameters:

input - The Attribute that defines the dimension attribute

Returns:

The AttributeProjection that defines the dimension attribute for this hierarchy