oracle.AWXML
Class Allocation

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

Direct Known Subclasses:

AllocationHierarchySpecification

public abstract class Allocation

extends BaseObject

Specifies the rules for allocating data to a measure for members of a hierarchy of a dimension. An Allocation is a component of an AllocationDefinition, which specifies a set of allocation instructions for a measure. An AllocationDefinition is implemented as an aggmap object of type ALLOCMAP in the OLAP DML. Each of the Allocationobjects of an AllocationDefinition is a RELATION statement in the aggmap.

Allocation objects are ordered within an AllocationDefinition. An Allocation has an AllocationOperator and one or more AllocationArgument objects. The concrete subclass of Allocation is AllocationHierarchySpecification.

For more information on OLAP allocation, see the OLAP DML Reference.

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

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

Method Summary

java.lang.String	Create(AWConnection connection) Creates the Allocation in the current analytic workspace of the specified database connection.
AllocationArgument	createAllocationArgument() Creates an AllocationArgument and makes it the AllocationArgument for the Allocation.
AllocationOperator	createAllocationOperator() Creates an AllocationOperator and specifies it as the AllocationOperator for the Allocation.
AllocationArgument	getAllocationArguments() Gets the AllocationArgument for the Allocation.
AllocationOperator	getAllocationOperator() Gets the AllocationOperator for the Allocation.
int	getCalculationOrder() Gets the position of the Allocation in the calculation list of the AllocationDefinition that owns it.
java.lang.String	getNaOperator() Gets the operator that the allocation operation uses when it encounters an NA or lock-based deadlock.
java.lang.String	getRemOperator() Gets the operator that the specifies where the allocation operation stores any remainder value.
void	setAllocationArgument(AllocationArgument input) Specifies an AllocationArgument for the Allocation; the AllocationArgument has one or more Parameter objects that specify additional parameters for the allocation operation.
void	setAllocationOperator(AllocationOperator input) Specifies an AllocationOperator for the Allocation; the AllocationOperator has an OperatorType that specifies the method of allocating data to the measure for the dimension members.
void	setCalculationOrder(int input) Specifies the position of the Allocation in the calculation list of the AllocationDefinition that owns it.
void	setCalculationOrder(java.lang.String input) Specifies the position of the Allocation in the calculation list of the AllocationDefinition that owns it.
void	setNaOperator(java.lang.String input) Specifies the operator that the allocation operation uses when it encounters an NA or lock-based deadlock.
void	setRemOperator(java.lang.String input) Specifies the operator that the allocation operation uses when it stores a remainder.
java.lang.String	WriteToXML() Gets an XML representation of the Allocation.

Methods inherited from class oracle.AWXML.BaseObject

Alter, CreateAfter, CreateBefore, CreateFirst, DataRead, Delete, 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

Allocation

public Allocation(BaseObject input)

Creates an Allocation for the specified AllocationDefinition.

Parameters:

input - The AllocationDefinition that owns the Allocation.

Method Detail

WriteToXML

public java.lang.String WriteToXML()

Gets an XML representation of the Allocation.

Overrides:

WriteToXML in class BaseObject

Returns:

An XML String that represents the Allocation.

getAllocationOperator

public AllocationOperator getAllocationOperator()

Gets the AllocationOperator for the Allocation.

Returns:

The AllocationOperator specified by this Allocation.

setAllocationOperator

public void setAllocationOperator(AllocationOperator input)

Specifies an AllocationOperator for the Allocation; the AllocationOperator has an OperatorType that specifies the method of allocating data to the measure for the dimension members. For a list of allocation operators, see AllocationOperator.

Parameters:

input - The AllocationOperator that you want this Allocation to have.

setAllocationArgument

public void setAllocationArgument(AllocationArgument input)

Specifies an AllocationArgument for the Allocation; the AllocationArgument has one or more Parameter objects that specify additional parameters for the allocation operation. Each Parameter has a keyword and a value. For a list of allocation arguments keywords, see Parameter.

Parameters:

input - The AllocationArgument that you want this Allocation to have.

getAllocationArguments

public AllocationArgument getAllocationArguments()

Gets the AllocationArgument for the Allocation.

Returns:

The AllocationArgument specified by this Allocation.

createAllocationOperator

public AllocationOperator createAllocationOperator()

Creates an AllocationOperator and specifies it as the AllocationOperator for the Allocation.

Returns:

The new AllocationOperator.

createAllocationArgument

public AllocationArgument createAllocationArgument()

Creates an AllocationArgument and makes it the AllocationArgument for the Allocation.

Returns:

The new AllocationArgument.

getNaOperator

public java.lang.String getNaOperator()

Gets the operator that the allocation operation uses when it encounters an NA or lock-based deadlock. Valid operators are HFIRST, HLAST,and HEVEN.

Returns:

A String that contains the operator specified for an NA or lock-based deadlock condition.

setNaOperator

public void setNaOperator(java.lang.String input)

Specifies the operator that the allocation operation uses when it encounters an NA or lock-based deadlock. Valid operators are HFIRST, HLAST,and HEVEN.

Parameters:

input - A String that contains the operator that you want to use for an NA or lock-based deadlock condition.

getRemOperator

public java.lang.String getRemOperator()

Gets the operator that the specifies where the allocation operation stores any remainder value. Valid operators are MIN, MAX, FIRST, LAST, HFIRST, and HLAST.

Returns:

A String that contains the operator specified for storing a remainder.

setRemOperator

public void setRemOperator(java.lang.String input)

Specifies the operator that the allocation operation uses when it stores a remainder. Valid operators are MIN, MAX, FIRST, LAST, HFIRST, and HLAST.

Parameters:

input - A String that contains the operator that you want to use for an NA or lock-based deadlock condition.

Create

public java.lang.String Create(AWConnection connection)

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

Overrides:

Create in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

A String that contains success if the method creates the Allocation.

setCalculationOrder

public void setCalculationOrder(int input)

Specifies the position of the Allocation in the calculation list of the AllocationDefinition that owns it. The analytic workspace performs the allocations in the order in which they appear in the list.

Parameters:

input - An integer that specifies the position that you want the Allocation to have in the calculation list.

setCalculationOrder

public void setCalculationOrder(java.lang.String input)

Specifies the position of the Allocation in the calculation list of the AllocationDefinition that owns it. The analytic workspace performs the allocations in the order in which they appear in the list.

Parameters:

input - A String that specifies the position that you want the Allocation to have in the calculation list.

getCalculationOrder

public int getCalculationOrder()

Gets the position of the Allocation in the calculation list of the AllocationDefinition that owns it.

Returns:

An integer that indicates the position of the Allocation in the calculation list.