Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)

B14351-01

oracle.AWXML
Class SolveDefDimRef

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

public class SolveDefDimRef
extends BaseObject

A dimension reference in a SolveDefinition.


Fields inherited from class oracle.AWXML.BaseObject
DATABASENULL

Constructor Summary
SolveDefDimRef(BaseObject input)
Creates a SolveDefDimRef in the specified SolveDefinition.

Method Summary
java.lang.String Create(AWConnection connection)
Creates a SolveDefDimRef in the current analytic workspace of the specified database connection.
java.lang.String CreateAfter(AWConnection connection, BaseObject referencedObj)
Creates a BaseObject and adds it after the referenced object in a sequence of objects in the current analytic workspace of the specified database connection.
java.lang.String CreateBefore(AWConnection connection, BaseObject referencedObj)
Creates a BaseObject and adds it before the referenced object in a sequence in the current analytic workspace of the specified database connection.
java.lang.String CreateFirst(AWConnection connection)
Creates a SolveDefDimRef in the current analytic workspace of the specified database connection.
java.lang.String Delete(AWConnection connection)
Deletes the object in the current analytic workspace of the specified database connection.
java.lang.String getCalcMemberSolveOrder()
Returns the solve order for a dimension that has dynamically-calculated members.
Dimension getDimension()
Returns the dimension in the SolveDefDimRef.
SolveDefinition getSolveDefinition()
Returns the SolveDefinition that uses this dimension reference.
void setCalcMemberSolveOrder(java.lang.String input)
Sets the solve order for a dimension that has dynamically-calculated members.
void setDimension(Dimension input)
Sets the dimension in the SolveDefDimRef.
void setSolveDefinition(SolveDefinition input)
Sets the SolveDefinition that will use this dimension reference.
java.lang.String WriteToXML()
Returns the SolveDefDimRef as an XML string.

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

SolveDefDimRef

public SolveDefDimRef(BaseObject input)
Creates a SolveDefDimRef in the specified SolveDefinition.
Parameters:
input - The SolveDefinition that owns the SolveDefDimRef.

Method Detail

setSolveDefinition

public void setSolveDefinition(SolveDefinition input)
Sets the SolveDefinition that will use this dimension reference.
Parameters:
input - The owning SolveDefinition.

getSolveDefinition

public SolveDefinition getSolveDefinition()
Returns the SolveDefinition that uses this dimension reference.
Returns:
The owning SolveDefinition.

setDimension

public void setDimension(Dimension input)
Sets the dimension in the SolveDefDimRef.
Parameters:
input - The Dimension.

getDimension

public Dimension getDimension()
Returns the dimension in the SolveDefDimRef.
Returns:
The Dimension.

getCalcMemberSolveOrder

public java.lang.String getCalcMemberSolveOrder()
Returns the solve order for a dimension that has dynamically-calculated members.

In some cases, a SessionCalculatedMember might execute dynamic calculations that override the default solve order in the AggregationDefinition.

The number returned by the getCalcMemberSolveOrder method specifies the dimension's position in the solve order. If the method returns "0" (default), the default solve order cannot be overridden.

This method is only meaningful for dimensions that have one or more SessionCalculatedMember objects.

Returns:
A String specifying the numeric position in the solve order. Default value is "0".

setCalcMemberSolveOrder

public void setCalcMemberSolveOrder(java.lang.String input)
Sets the solve order for a dimension that has dynamically-calculated members.

In some cases, a SessionCalculatedMember might execute dynamic calculations that override the default solve order in the AggregationDefinition.

The setCalcMemberSolveOrder method specifies the dimension's position in the solve order. If the position is zero (default), the default solve order cannot be overridden.

This method is only meaningful for dimensions that have one or more SessionCalculatedMember objects.

Parameters:
input - A String specifying the numeric position in the solve order. Default value is "0".

WriteToXML

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

Create

public java.lang.String Create(AWConnection connection)
Creates a SolveDefDimRef 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:
"success" if successful.

Delete

public java.lang.String Delete(AWConnection connection)
Description copied from class: BaseObject
Deletes the object in the current analytic workspace of the specified database connection.
Overrides:
Delete in class BaseObject
Tags copied from class: BaseObject
Parameters:
connection - The AWConnection that represents database connection.
Returns:
If successful, a String that contains success.

CreateFirst

public java.lang.String CreateFirst(AWConnection connection)
Creates a SolveDefDimRef in the current analytic workspace of the specified database connection.
Overrides:
CreateFirst in class BaseObject
Parameters:
connection - The AWConnection that specifies the database connection.
Returns:
"success" if successful.

CreateAfter

public java.lang.String CreateAfter(AWConnection connection,
                                    BaseObject referencedObj)
Description copied from class: BaseObject
Creates a BaseObject and adds it after the referenced object in a sequence of objects in the current analytic workspace of the specified database connection. Use this method only to create a BaseObject that you want to add to a sequence.
Overrides:
CreateAfter in class BaseObject
Tags copied from class: BaseObject
Parameters:
connection - The AWConnection that represents the database connection.
referencedObj - The BaseObject in the sequence after which to add the new BaseObject.
Returns:
If successful, a String that contains success.

CreateBefore

public java.lang.String CreateBefore(AWConnection connection,
                                     BaseObject referencedObj)
Description copied from class: BaseObject
Creates a BaseObject and adds it before the referenced object in a sequence in the current analytic workspace of the specified database connection. Use this method only to create a BaseObject that you want to add to a sequence.
Overrides:
CreateBefore in class BaseObject
Tags copied from class: BaseObject
Parameters:
connection - The AWConnection that represents the database connection.
referencedObj - The BaseObject in the sequence before which to add the new BaseObject.
Returns:
If successful, a String that contains success.

Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)

B14351-01

Copyright © 2003, 2005 Oracle. All rights reserved.