oracle.AWXML
Class AW

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

public class AW

extends BaseObject

Serves as a container for objects. An AW object does not participate in the hierarchy of logical objects, but each object that will be instantiated in an analytic workspace must be associated with an AW object.

The top-level objects in the hierarchy are owned by a schema, not by an AWobject. Top-level objects are: Cubes, Dimensions, SolveDefinitions, Solves, and Models.

See Also:

oracle.AWXML.AWObject

s_curAW

public static AW s_curAW

s_allObjectsObj

public static java.lang.String s_allObjectsObj

s_allDimsObj

public static java.lang.String s_allDimsObj

s_allLevelsObject

public static java.lang.String s_allLevelsObject

s_allHierarchiesObject

public static java.lang.String s_allHierarchiesObject

s_allAttributesObject

public static java.lang.String s_allAttributesObject

s_relationalAttributeData

public static java.lang.String s_relationalAttributeData

s_cubeListObject

public static java.lang.String s_cubeListObject

s_measureListObject

public static java.lang.String s_measureListObject

s_mapGroupListObject

public static java.lang.String s_mapGroupListObject

s_mapMeasureObject

public static java.lang.String s_mapMeasureObject

s_mapKeyObject

public static java.lang.String s_mapKeyObject

s_mapAttrObject

public static java.lang.String s_mapAttrObject

s_mapParentObject

public static java.lang.String s_mapParentObject

s_attrVisibleObject

public static java.lang.String s_attrVisibleObject

s_solveDfnObj

public static java.lang.String s_solveDfnObj

s_solveDfnTypeObj

public static java.lang.String s_solveDfnTypeObj

s_solveDfnSolveOrderObj

public static java.lang.String s_solveDfnSolveOrderObj

s_solveDfnCalculationOrderObj

public static java.lang.String s_solveDfnCalculationOrderObj

s_aggSolveDefPropObj

public static java.lang.String s_aggSolveDefPropObj

s_aggSolveDefCatalogObj

public static java.lang.String s_aggSolveDefCatalogObj

s_allocSolveDefPropObj

public static java.lang.String s_allocSolveDefPropObj

s_allocSolveDefCatalogObj

public static java.lang.String s_allocSolveDefCatalogObj

s_forecastPropObj

public static java.lang.String s_forecastPropObj

s_forecastCatalogObj

public static java.lang.String s_forecastCatalogObj

s_cubeSparseDimsObj

public static java.lang.String s_cubeSparseDimsObj

s_cubeDfltAggregationObj

public static java.lang.String s_cubeDfltAggregationObj

s_cubeDfltHierPartObj

public static java.lang.String s_cubeDfltHierPartObj

s_cubeDfltLvlPartObj

public static java.lang.String s_cubeDfltLvlPartObj

s_measSparseDimsObj

public static java.lang.String s_measSparseDimsObj

s_measCatalogObj

public static java.lang.String s_measCatalogObj

s_measPropObj

public static java.lang.String s_measPropObj

s_measLvlPartObj

public static java.lang.String s_measLvlPartObj

s_measHierPartObj

public static java.lang.String s_measHierPartObj

s_measAggregationObj

public static java.lang.String s_measAggregationObj

s_allSolvesObj

public static java.lang.String s_allSolvesObj

s_allSolvesTargetObj

public static java.lang.String s_allSolvesTargetObj

s_allSolvesSourceObj

public static java.lang.String s_allSolvesSourceObj

s_allSolvesBaseObj

public static java.lang.String s_allSolvesBaseObj

s_allSolvesMSObj

public static java.lang.String s_allSolvesMSObj

s_allSolvesOrderObj

public static java.lang.String s_allSolvesOrderObj

s_allSolvesSolveDfnObj

public static java.lang.String s_allSolvesSolveDfnObj

AW

public AW()

Constructor for AW. Creates a new AW object.

getCurAW

public static AW getCurAW()

Returns the current AW object.

Returns:

An AW.

setCurAW

public static void setCurAW(AW input)

Sets the current AW object.

Parameters:

input - An AW.

WriteToXML

public java.lang.String WriteToXML()

Returns the AW object as an XML string.

Overrides:

WriteToXML in class BaseObject

Returns:

A String containing the XML that represents the AW.

addDimension

public void addDimension(Dimension input)

Adds a dimension to an analytic workspace.

Parameters:

input - The Dimension to add to the AW.

See Also:

Dimension

removeDimension

public void removeDimension(Dimension input)

Removes a dimension from an analytic workspace.

Parameters:

input - The Dimension to remove from the AW.

getDimensions

public java.util.Vector getDimensions()

Returns the dimensions that are stored in the analytic workspace.

Returns:

A Vector containing the list of dimensions in the AW.

addCube

public void addCube(Cube input)

Adds a cube to an analytic workspace.

Parameters:

input - The Cube to add to the AW.

See Also:

Cube

removeCube

public void removeCube(Cube input)

Removes a cube from an analytic workspace.

Parameters:

input - The Cube to remove from the AW.

getCubes

public java.util.Vector getCubes()

Returns the cubes that are stored in the analytic workspace.

Returns:

A Vector containing the list of cubes in the AW.

addSolveDefinition

public void addSolveDefinition(SolveDefinition input)

Adds a SolveDefinition to an analytic workspace. A SolveDefinition contains static information used to generate Solves (Aggregations, Allocations, and Forecasts).

The SolveDefinition for an Aggregation is an aggmap, a workspace object that contains instructions for storing aggregate data. The SolveDefinition for an Allocation is an allocmap, a workspace object that contains instructions for storing allocated data. The SolveDefinitionfor a Forecast is a collection of properties that can be reused by different forecasts.

Parameters:

input - The SolveDefinition object to add to the AW.

See Also:

SolveDefinition

removeSolveDefinition

public void removeSolveDefinition(SolveDefinition input)

Removes a SolveDefinition from an analytic workspace.

Parameters:

input - The SolveDefinition to remove from the AW.

getSolveDefinitions

public java.util.Vector getSolveDefinitions()

Returns the SolveDefinitions that are stored in the analytic workspace.

Returns:

A Vector containing the list of SolveDefinition objects in the AW.

addSolve

public void addSolve(Solve input)

Adds a Solve to an analytic workspace. A Solve can be an Aggregation, an Allocation, or a ForecastSolve.

Parameters:

input - The SolveDefinition object to add to the AW.

See Also:

Solve

addSolveBefore

public void addSolveBefore(Solve input,
BaseObject reference)

Adds a Solve before the specified object in the analytic workspace.

Parameters:

input - A Solve to add to the workspace.

reference - The BaseObject that should be preceded by the Solve.

addSolveAfter

public void addSolveAfter(Solve input,
BaseObject reference)

Adds a Solve after the specified object in the analytic workspace.

Parameters:

input - A Solve to add to the workspace.

reference - The BaseObject that should precede the Solve.

addSolveFirst

public void addSolveFirst(Solve input)

Adds a Solve as the first in a collection of Solves in the analytic workspace.

Parameters:

input - The Solve to add.

removeSolve

public void removeSolve(Solve input)

Removes a Solve from an analytic workspace.

Parameters:

input - The Solve to remove.

getSolves

public java.util.Vector getSolves()

Returns the Solves in the analytic workspace.

Returns:

a Vector containing a list of Solve objects.

addModel

public void addModel(Model input)

Adds a Model to an analytic workspace. A Model is a workspace object that contains a set of interrelated equations. The results of a model can be assigned to a derived measure or dimension member.

Parameters:

input - The Model object to add to the AW.

See Also:

Model

removeModel

public void removeModel(Model input)

Removes a Model from an analytic workspace.

Parameters:

input - The Model object to remove from the AW.

getModels

public java.util.Vector getModels()

Returns the Models in the analytic workspace.

Returns:

a Vector containing a list of Model objects.

createDimension

public Dimension createDimension()

Creates a Dimension. The new Dimension may be be added to an analytic workspace with the AddDimension method, or it may be added to a user-defined container.

Returns:

a new Dimension

See Also:

Dimension

createCube

public Cube createCube()

Creates a Cube. The new Cube may be be added to an analytic workspace with the AddCube method, or it may be added to a user-defined container.

Returns:

a new Cube

See Also:

Cube

createForecastDefinition

public ForecastDefinition createForecastDefinition()

Creates a ForecastDefinition. The new ForecastDefinition may be be added to an analytic workspace with the AddForecastDefinition method, or it may be added to a user-defined container.

Returns:

a new ForecastDefinition

See Also:

ForecastDefinition

createAllocationDefinition

public AllocationDefinition createAllocationDefinition()

Creates an AllocationDefinition. The new AllocationDefinition may be be added to an analytic workspace with the AddAllocationDefinition method, or it may be added to a user-defined container.

Returns:

a new AllocationDefinition

See Also:

AllocationDefinition

createAggregationDefinition

public AggregationDefinition createAggregationDefinition()

Creates an AggregationDefinition. The new AggregationDefinition may be be added to an analytic workspace with the AddAggregationDefinition method, or it may be added to a user-defined container.

Returns:

a new AggregationDefinition

See Also:

AggregationDefinition

createAggregationSolve

public AggregationSolve createAggregationSolve()

Creates an AggregationSolve. The new AggregationSolve may be be added to an analytic workspace with the AddAggregationSolve method, or it may be added to a user-defined container.

Returns:

a new AggregationSolve

See Also:

AggregationSolve

createAggregationSolveAfter

public AggregationSolve createAggregationSolveAfter(Solve input)

Creates a new AggregationSolve after the specified Solve in the analytic workspace.

Parameters:

input - A Solve.

Returns:

The new AggregationSolve that should be preceded by the Solve.

createAggregationSolveBefore

public AggregationSolve createAggregationSolveBefore(Solve input)

Creates a new AggregationSolve before the specified Solve in the analytic workspace.

Parameters:

input - A Solve.

Returns:

The new AggregationSolve that should precede the Solve.

createAggregationSolveFirst

public AggregationSolve createAggregationSolveFirst()

Creates the first AggregationSolve in a series of AggregationSolve objects in the analytic workspace.

Returns:

The new AggregationSolve that should be first in the series.

createAllocationSolve

public AllocationSolve createAllocationSolve()

Creates an AllocationSolve. The new AllocationSolve may be be added to an analytic workspace with the AddAllocationSolve method, or it may be added to a user-defined container.

Returns:

a new AllocationSolve

See Also:

AllocationSolve

createAllocationSolveAfter

public AllocationSolve createAllocationSolveAfter(Solve input)

Creates a new AllocationSolve after the specified Solve in the analytic workspace.

Parameters:

input - A Solve.

Returns:

The new AllocationSolve that should be preceded by the Solve.

createAllocationSolveBefore

public AllocationSolve createAllocationSolveBefore(Solve input)

Creates a new AllocationSolve before the specified Solve in the analytic workspace.

Parameters:

input - A Solve.

Returns:

The new AllocationSolve that should precede the Solve.

createAllocationSolveFirst

public AllocationSolve createAllocationSolveFirst()

Creates the first AllocationSolve in a series of AllocationSolve objects in the analytic workspace.

Returns:

The new AllocationSolve that should be first in the series.

createForecastSolve

public ForecastSolve createForecastSolve()

Creates a ForecastSolve. The new ForecastSolve may be be added to an analytic workspace with the AddForecastSolve method, or it may be added to a user-defined container.

Returns:

a new ForecastSolve

See Also:

ForecastSolve

createForecastSolveAfter

public ForecastSolve createForecastSolveAfter(Solve input)

Creates a new ForecastSolve after the specified Solve in the analytic workspace.

Parameters:

input - A Solve.

Returns:

The new ForecastSolve that should be preceded by the Solve.

createForecastSolveBefore

public ForecastSolve createForecastSolveBefore(Solve input)

Creates a new ForecastSolve before the specified Solve in the analytic workspace.

Parameters:

input - A Solve.

Returns:

The new ForecastSolve that should precede the Solve.

createForecastSolveFirst

public ForecastSolve createForecastSolveFirst()

Creates the first ForecastSolve in a series of ForecastSolve objects in the analytic workspace.

Returns:

The new ForecastSolve that should be first in the series.

createModel

public Model createModel()

Creates a Model. A Model is a workspace object that contains a set of interrelated equations. The results of a model can be assigned to a derived measure or dimension member.

The new Model may be be added to an analytic workspace with the AddModel method, or it may be added to a user-defined container.

Returns:

a new Model

See Also:

Model

Create

public java.lang.String Create(AWConnection connection)

In the specified OLAP session, creates the analytic workspace and defines the workspace objects.

Overrides:

Create in class BaseObject

Parameters:

connection - an AWConnection

Returns:

String

Attach

public void Attach(AWConnection connection,
                   java.lang.String mode)

In the specified OLAP session, attaches the analytic workspace.

Parameters:

connection - an AWConnection

mode - a String specifying the attach mode. "RO" for read-only. "RW" for read-write.

Detach

public void Detach(AWConnection connection)

In the specified OLAP session, detaches the analytic workspace.

Parameters:

connection - an AWConnection

Commit

public void Commit(AWConnection connection)

In the specified OLAP session, commits the changes to the analytic workspace.

Parameters:

connection - an AWConnection

readAWDefinitions

public static AW readAWDefinitions(AWConnection connection,
                                   java.lang.String awName)

In the specified OLAP session, reads the standard form object definitions in the specified analytic workspace and copies them into a new AW.

Parameters:

connection - an AWConnection

awName - a String specifying the name of an analytic workspace

Returns:

a new AW containing the object definitions

findDimension

public Dimension findDimension(java.lang.String inputName)

Returns:

 

findCube

public Cube findCube(java.lang.String inputName)

Returns:

 

findAggregationDefinition

public AggregationDefinition findAggregationDefinition(java.lang.String name)

Returns:

 

findAllocationDefinition

public AllocationDefinition findAllocationDefinition(java.lang.String name)

Returns:

 

findForecastDefinition

public ForecastDefinition findForecastDefinition(java.lang.String name)

Returns:

 

getPhysicalMetaDataNames

public static void getPhysicalMetaDataNames(AWConnection connection)

readAWTopLevelDefinitions

public static AW readAWTopLevelDefinitions(AWConnection connection,
                                           java.lang.String awName)

In the specified OLAP session, reads the standard form top level object definitions in the specified analytic workspace and copies them into a new AW.

Parameters:

connection - an AWConnection

awName - a String specifying the name of an analytic workspace

Returns:

a new AW containing the object definitions