Oracle OLAP Analytic Workspace Java API Reference
10g Release 1 (10.1)

B12180-01

oracle.AWXML
Class HierarchyLevelAssociation

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

public class HierarchyLevelAssociation
extends AWObject
implements DerivedMeasureInput

A HierarchyLevelAssociation associates a Level with a Hierarchy.

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

A HierarchyLevelAssociation is owned by a Hierarchy.

The HierarchyLevelAssociation class implements the DerivedMeasureInput interface, allowing a hierarchical level to be used as input to the calculations that define a derived measure.


Fields inherited from class oracle.AWXML.AWObject
m_attributes, m_refreshMapGroup, m_sourceMapGroup

 

Fields inherited from class oracle.AWXML.BaseObject
AWNULL, DATABASENULL, m_commandResults, m_commandResultText, m_id, m_listResults, m_longName, m_name, m_owner, m_pluralName, m_schema, m_shortName, s_EndElementTag, s_EndEndTag, s_EndStartTag, s_EndTag, s_Indent, s_JAVA_LINEEND, s_NEWLINE, s_objectCounter, s_StartEndTag, s_StartStartTag

 

Constructor Summary
HierarchyLevelAssociation(BaseObject input)
          Creates a new HierarchyLevelAssociation for the specified Hierarchy.

 

Method Summary
 java.lang.String Create(AWConnection connection)
          Creates the HierarchyLevelAssociation for a hierarchy in the current analytic workspace of the specified connection.
 java.lang.String CreateAfter(AWConnection connection, BaseObject referencedObj)
          Creates a new HierarchyLevelAssociation for the Hierarchy in the current analytic workspace.
 java.lang.String CreateBefore(AWConnection connection, BaseObject referencedObj)
          Creates a new HierarchyLevelAssociation for the Hierarchy in the current analytic workspace.
 java.lang.String CreateFirst(AWConnection connection)
          Creates a new HierarchyLevelAssociation for the Hierarchy in the current analytic workspace.
 java.lang.String Delete(AWConnection connection)
          Deletes the HierarchyLevelAssociation from the hierarchy in the current analytic workspace of the specified connection.
 AttributeProjection findAttributeProjection(Attribute input)
          Returns the attribute (AttributeProjection) of this HierarchyLevelAssociation that corresponds to the specified dimension attribute (Attribute).
 Level getLevel()
          Returns the Level in this HierarchyLevelAssociation.
 void setLevel(Level input)
          Sets the Level for this HierarchyLevelAssociation, causing this level to be a member of this hierarchy.
 java.lang.String WriteToXML()
          Returns the HierarchyLevelAssociation as an XML string.

 

Methods inherited from class oracle.AWXML.AWObject
addAttribute, addAttributeProjection, addRefreshMapGroup, addSourceCubeMapGroup, addSourceDimensionMapGroup, addSourceMappingGroup, createAttribute, createAttributeProjection, createSourceCubeMapGroup, createSourceDimensionMapGroup, getAttributes, getRefreshMapGroup, getSourceMapGroup, removeAttribute, removeAttributeProjection, removeSourceMappingGroup

 

Methods inherited from class oracle.AWXML.BaseObject
Alter, getId, getLongName, getName, getOwner, getParentId, getPluralName, getSchema, getShortName, setLongName, setName, setPluralName, setSchema, setShortName

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

HierarchyLevelAssociation

public HierarchyLevelAssociation(BaseObject input)
Creates a new HierarchyLevelAssociation for the specified Hierarchy.

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

Parameters:
input - A BaseObject representing the parent hierarchy
Method Detail

WriteToXML

public java.lang.String WriteToXML()
Returns the HierarchyLevelAssociation as an XML string.
Overrides:
WriteToXML in class AWObject
Returns:
A String containing the XML that represents the HierarchyLevelAssociation.

setLevel

public void setLevel(Level input)
Sets the Level for this HierarchyLevelAssociation, causing this level to be a member of this hierarchy.
Parameters:
input - The Level to associate with the hierarchy

getLevel

public Level getLevel()
Returns the Level in this HierarchyLevelAssociation.
Returns:
The Level

Delete

public java.lang.String Delete(AWConnection connection)
Deletes the HierarchyLevelAssociation from the hierarchy in the current analytic workspace of the specified connection.
Overrides:
Delete in class BaseObject
Parameters:
connection - The AWConnection that defines the connection
Returns:
String

Create

public java.lang.String Create(AWConnection connection)
Creates the HierarchyLevelAssociation for a hierarchy in the current analytic workspace of the specified connection.
Overrides:
Create in class BaseObject
Parameters:
connection - The AWConnection that defines the connection
Returns:
String

CreateFirst

public java.lang.String CreateFirst(AWConnection connection)
Creates a new HierarchyLevelAssociation for the Hierarchy in the current analytic workspace. 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.

Overrides:
CreateFirst in class BaseObject
Parameters:
The - AWConnection that defines the current connection
Returns:
String

CreateAfter

public java.lang.String CreateAfter(AWConnection connection,
BaseObject referencedObj)
Creates a new HierarchyLevelAssociation for the Hierarchy in the current analytic workspace. 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.

Overrides:
CreateAfter in class BaseObject
Parameters:
connection - The AWConnection that defines the connection
referencedObj - The BaseObject that represents the HierarchyLevelAssociation after which the new object should be created
Returns:
String

CreateBefore

public java.lang.String CreateBefore(AWConnection connection,
BaseObject referencedObj)
Creates a new HierarchyLevelAssociation for the Hierarchy in the current analytic workspace. 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.

Overrides:
CreateBefore in class BaseObject
Parameters:
connection - The AWConnection that defines the connection
referencedObj - The BaseObject that represents the HierarchyLevelAssociation before which the new object should be created
Returns:
String

findAttributeProjection

public AttributeProjection findAttributeProjection(Attribute input)
Returns the attribute (AttributeProjection) of this HierarchyLevelAssociation 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 hierarchical level

Oracle OLAP Analytic Workspace Java API Reference
10g Release 1 (10.1)

B12180-01

Copyright © 2003, Oracle. All Rights Reserved.