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

B12180-01

oracle.AWXML
Class AllocationDefinition

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.SolveDefinition
              |
              +--oracle.AWXML.AllocationDefinition

public class AllocationDefinition
extends SolveDefinition

The allocation rules for a measure or a group of measures within a cube. The allocation rules are formulated as an allocmap in the OLAP DML. An allocmap applies allocation rules to an aggregation map.

The aggregation map on which the allocmap is based specifies which data should be precalculated and which should be calculated on the fly. The aggregation map consists of one or more CalculationSpecifications, each one specifying an ordered set of RELATION and MODEL statements in the aggregation map.

The allocmap includes a CHILDLOCK statement and a DEADLOCK statement. The CHILDLOCK statement tells the ALLOCATE command whether to determine if RELATION statements in the aggregation map specify a lock on both a parent and a child element of a dimension hierarchy. A DEADLOCK statement tells the ALLOCATE command whether to continue an allocation when it encounters a deadlock, which occurs when the allocation cannot distribute a value because the targeted cell is locked or, for some operations, has a basis value of NA.

Use the following link to view a graphical representation of oracle.AWXML.AllocationDefinition.

OLAP Analytic Workspace Allocation Definition Model

For more information, see the ALLOCATE command in the OLAP DML Reference.


Field Summary
protected  java.util.Vector m_allocations
           
protected  java.lang.String m_childLock
           
protected  java.lang.String m_deadLock
           
protected  java.lang.String m_sourceVal
           

 

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

 

Method Summary
 void addAllocation(Allocation input)
           
 void addAllocationAfter(Allocation input, BaseObject reference)
           
 void addAllocationBefore(Allocation input, BaseObject reference)
           
 void addAllocationFirst(Allocation input)
           
 java.lang.String Create(AWConnection connection)
          Creates the current object in the analytic workspace.
 AllocationHierarchySpecification createAllocateHierarchySpecification()
           
 AllocationHierarchySpecification createAllocateHierarchySpecificationAfter(Allocation input)
           
 AllocationHierarchySpecification createAllocateHierarchySpecificationBefore(Allocation input)
           
 AllocationHierarchySpecification createAllocateHierarchySpecificationFirst()
           
 java.lang.String Delete(AWConnection connection)
          Deletes the current object from the analytic workspace.
 java.util.Vector getAllocations()
           
 java.lang.String getChildLock()
           
 java.lang.String getDeadLock()
           
 java.lang.String getSourceVal()
           
 void readAWMetaData(AWConnection connection)
           
 void removeAllocation(Allocation input)
           
 void setChildLock(java.lang.String input)
           
 void setDeadLock(java.lang.String input)
           
 void setSourceVal(java.lang.String input)
           
 java.lang.String WriteToXML()
          Returns the object as an XML string.

 

Methods inherited from class oracle.AWXML.SolveDefinition
getId, getParentId

 

Methods inherited from class oracle.AWXML.BaseObject
Alter, CreateAfter, CreateBefore, CreateFirst, getLongName, getName, getOwner, 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

 

Field Detail

m_allocations

protected java.util.Vector m_allocations

m_sourceVal

protected java.lang.String m_sourceVal

m_deadLock

protected java.lang.String m_deadLock

m_childLock

protected java.lang.String m_childLock
Constructor Detail

AllocationDefinition

public AllocationDefinition()
Default Constructor

AllocationDefinition

public AllocationDefinition(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

getSourceVal

public java.lang.String getSourceVal()
Returns:
 

setSourceVal

public void setSourceVal(java.lang.String input)
Returns:
 

getDeadLock

public java.lang.String getDeadLock()
Returns:
 

setDeadLock

public void setDeadLock(java.lang.String input)
Returns:
 

getChildLock

public java.lang.String getChildLock()
Returns:
 

setChildLock

public void setChildLock(java.lang.String input)
Returns:
 

WriteToXML

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

addAllocation

public void addAllocation(Allocation input)
Returns:
 

addAllocationAfter

public void addAllocationAfter(Allocation input,
BaseObject reference)
Returns:
 

addAllocationBefore

public void addAllocationBefore(Allocation input,
BaseObject reference)
Returns:
 

addAllocationFirst

public void addAllocationFirst(Allocation input)
Returns:
 

removeAllocation

public void removeAllocation(Allocation input)
Returns:
 

getAllocations

public java.util.Vector getAllocations()
Returns:
 

createAllocateHierarchySpecification

public AllocationHierarchySpecification createAllocateHierarchySpecification()
Returns:
 

createAllocateHierarchySpecificationAfter

public AllocationHierarchySpecification createAllocateHierarchySpecificationAfter(Allocation input)
Returns:
 

createAllocateHierarchySpecificationBefore

public AllocationHierarchySpecification createAllocateHierarchySpecificationBefore(Allocation input)
Returns:
 

createAllocateHierarchySpecificationFirst

public AllocationHierarchySpecification createAllocateHierarchySpecificationFirst()
Returns:
 

Create

public java.lang.String Create(AWConnection connection)
Description copied from class: BaseObject
Creates the current object in the analytic workspace.
Overrides:
Create in class BaseObject
Returns:
 

Delete

public java.lang.String Delete(AWConnection connection)
Description copied from class: BaseObject
Deletes the current object from the analytic workspace.
Overrides:
Delete in class BaseObject
Returns:
 

readAWMetaData

public void readAWMetaData(AWConnection connection)

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

B12180-01

Copyright © 2003, Oracle. All Rights Reserved.