oracle.AWXML
Class AllocationHierarchySpecification

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

public class AllocationHierarchySpecification

extends Allocation

A hierarchy specification in an Allocation.

An AllocationHierarchySpecification may include a DimensionMemberSelection, which designates dimension levels or members to be included in the allocation.

AllocationHierarchySpecification objects are ordered within an AllocationDefinition.

See Also:

AllocationDefinition

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

AllocationHierarchySpecification(BaseObject input)
Creates an AllocationHierarchySpecification for the specified AllocationDefinition.

Method Summary

java.lang.String	Create(AWConnection connection) Creates the AllocationHierarchySpecification in the current analytic workspace of the specified database connection.
java.lang.String	CreateAfter(AWConnection connection, BaseObject referencedObj) Creates the AllocationHierarchySpecification after the specified Allocation in the analytic workspace of the specified database connection.
java.lang.String	CreateBefore(AWConnection connection, BaseObject referencedObj) Creates the AllocationHierarchySpecification before the specified Allocation in the current analytic workspace of the specified database connection.
java.lang.String	CreateFirst(AWConnection connection) Creates the AllocationHierarchySpecification at the beginning of list of Allocation objects for this AllocationDefinition in the analytic workspace of the specified database connection.
java.lang.String	Delete(AWConnection connection) Deletes the AllocationHierarchySpecification in the current analytic workspace of the specified database connection.
Dimension	getDimension() Returns the dimension in the AllocationHierarchySpecification.
Hierarchy	getHierarchy() Returns the hierarchy in the AllocationHierarchySpecification.
void	setDimension(Dimension input) Sets the dimension in the AllocationHierarchySpecification.
void	setHierarchy(Hierarchy input) Sets the hierarchy in the AllocationHierarchySpecification.
java.lang.String	WriteToXML() Returns the AllocationHierarchySpecification as an XML string.

Methods inherited from class oracle.AWXML.Allocation

createAllocationArgument, createAllocationOperator, getAllocationArguments, getAllocationOperator, getCalculationOrder, getNaOperator, getRemOperator, setAllocationArgument, setAllocationOperator, setCalculationOrder, setCalculationOrder, setNaOperator, setRemOperator

Methods inherited from class oracle.AWXML.BaseObject

Alter, 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

AllocationHierarchySpecification

public AllocationHierarchySpecification(BaseObject input)

Creates an AllocationHierarchySpecification for the specified AllocationDefinition.

Parameters:

input - The AllocationDefinition that uses this AllocationHierarchySpecification.

Method Detail

WriteToXML

public java.lang.String WriteToXML()

Returns the AllocationHierarchySpecification as an XML string.

Overrides:

WriteToXML in class Allocation

Returns:

A String containing the XML that represents the AllocationHierarchySpecification.

setHierarchy

public void setHierarchy(Hierarchy input)

Sets the hierarchy in the AllocationHierarchySpecification.

Parameters:

input - The allocation Hierarchy.

getHierarchy

public Hierarchy getHierarchy()

Returns the hierarchy in the AllocationHierarchySpecification.

Returns:

The allocation Hierarchy.

setDimension

public void setDimension(Dimension input)

Sets the dimension in the AllocationHierarchySpecification. The dimension must be the owner of the hierarchy.

Parameters:

input - The allocation Dimension.

getDimension

public Dimension getDimension()

Returns the dimension in the AllocationHierarchySpecification.

Returns:

The allocation Dimension.

Create

public java.lang.String Create(AWConnection connection)

Creates the AllocationHierarchySpecification in the current analytic workspace of the specified database connection. If other Allocation objects already exist for this AllocationDefinition, adds the new one to the end of the list.

Overrides:

Create in class Allocation

Parameters:

connection - The AWConnection that specifies the connection.

Returns:

"success" if successful.

CreateFirst

public java.lang.String CreateFirst(AWConnection connection)

Creates the AllocationHierarchySpecification at the beginning of list of Allocation objects for this AllocationDefinition in the analytic workspace of the specified database connection.

Overrides:

CreateFirst in class BaseObject

Parameters:

connection - The AWConnection that specifies the connection.

Returns:

"success" if successful.

CreateAfter

public java.lang.String CreateAfter(AWConnection connection,
                                    BaseObject referencedObj)

Creates the AllocationHierarchySpecification after the specified Allocation in the analytic workspace of the specified database connection.

Overrides:

CreateAfter in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

referencedObj - The referenced Allocation.

Returns:

"success" if successful.

CreateBefore

public java.lang.String CreateBefore(AWConnection connection,
                                     BaseObject referencedObj)

Creates the AllocationHierarchySpecification before the specified Allocation in the current analytic workspace of the specified database connection.

Overrides:

CreateBefore in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

referencedObj - The referenced Allocation.

Returns:

"success" if successful.

Delete

public java.lang.String Delete(AWConnection connection)

Deletes the AllocationHierarchySpecification in the current analytic workspace of the specified database connection.

Overrides:

Delete in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

"success" if successful.