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

B12180-01

oracle.AWXML
Class AllocationHierarchySpecification

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.Allocation
              |
              +--oracle.AWXML.AllocationHierarchySpecification

public class AllocationHierarchySpecification
extends Allocation

Specifies the allocation rules for a hierarchy of a dimension. The rules may designate specific levels or dimension members to include in the allocation. The selection of dimension members is specified in a DimensionMemberSelection object.

In the OLAP DML, the AllocationHierarchySpecification is a parent relation in the RELATION statement of the allocation map.

For more information, see the Oracle OLAP DML Reference.


Fields inherited from class oracle.AWXML.Allocation
m_arguments, m_calculationOrder, m_naOperator, m_operator, m_remOperator

 

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
AllocationHierarchySpecification(BaseObject input)
          Constructor that takes the owner of this object.

 

Method Summary
 java.lang.String Create(AWConnection connection)
          Creates a new AllocationHierarchySpecification in the analytic workspace.
 java.lang.String CreateAfter(AWConnection connection, BaseObject referencedObj)
          Creates the current object in the analytic workspace as part of an ordered set of objects after the specified object.
 java.lang.String CreateBefore(AWConnection connection, BaseObject referencedObj)
          Creates the current object in the analytic workspace as part of an ordered set of objects before the specified object.
 java.lang.String CreateFirst(AWConnection connection)
          Creates the current object in the analytic workspace first as part of an ordered set of objects.
 java.lang.String Delete(AWConnection connection)
          Removes the object from the analytic workspace.
 Dimension getDimension()
          Returns the Dimension of the Hierarchy.
 Hierarchy getHierarchy()
          Returns the hierarchy to which the allocation applies.
 void setDimension(Dimension input)
          Sets the Dimension of the Hierarchy.
 void setHierarchy(Hierarchy input)
          Sets the hierarchy for the allocation.
 java.lang.String WriteToXML()
          Returns the object as an XML string.

 

Methods inherited from class oracle.AWXML.Allocation
createAllocationArgument, createAllocationOperator, getAllocationArguments, getAllocationOperator, getAllocationText, getCalculationOrder, getNaOperator, getRemOperator, setAllocationArgument, setAllocationOperator, setCalculationOrder, setCalculationOrder, setNaOperator, setRemOperator

 

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

AllocationHierarchySpecification

public AllocationHierarchySpecification(BaseObject input)
Constructor that takes the owner of this object.
Parameters:
input - BaseObject that is the owner of this object in the object model
Method Detail

WriteToXML

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

setHierarchy

public void setHierarchy(Hierarchy input)
Sets the hierarchy for the allocation.
Parameters:
input - Hierarchy

getHierarchy

public Hierarchy getHierarchy()
Returns the hierarchy to which the allocation applies.
Returns:
Hierarchy

setDimension

public void setDimension(Dimension input)
Sets the Dimension of the Hierarchy.
Parameters:
input - Dimension

getDimension

public Dimension getDimension()
Returns the Dimension of the Hierarchy.
Returns:
Dimension

Create

public java.lang.String Create(AWConnection connection)
Creates a new AllocationHierarchySpecification in the analytic workspace.
Overrides:
Create in class Allocation
Parameters:
connection - AWConnection
Returns:
String containing "success" if successful

CreateFirst

public java.lang.String CreateFirst(AWConnection connection)
Creates the current object in the analytic workspace first as part of an ordered set of objects.
Overrides:
CreateFirst in class BaseObject
Parameters:
connection - A AWConnection that represents the current OLAP session
Returns:
String containing "success" if successful

CreateAfter

public java.lang.String CreateAfter(AWConnection connection,
BaseObject referencedObj)
Creates the current object in the analytic workspace as part of an ordered set of objects after the specified object.
Overrides:
CreateAfter in class BaseObject
Parameters:
connection - A AWConnection that represents the current OLAP session
referencedObj - A BaseObject that represents where in the ordered collection to insert the new object.
Returns:
String containing "success" if successful

CreateBefore

public java.lang.String CreateBefore(AWConnection connection,
BaseObject referencedObj)
Creates the current object in the analytic workspace as part of an ordered set of objects before the specified object.
Overrides:
CreateBefore in class BaseObject
Parameters:
connection - A AWConnection that represents the current OLAP session
referencedObj - A BaseObject that represents where in the ordered collection to insert the new object.
Returns:
String containing "success" if successful

Delete

public java.lang.String Delete(AWConnection connection)
Removes the object from the analytic workspace.
Overrides:
Delete in class BaseObject
Parameters:
connection - AWConnection
Returns:
String containing "success" if successful

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

B12180-01

Copyright © 2003, Oracle. All Rights Reserved.