oracle.AWXML
Class OlapMeasure

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.Measure
              |
              +--oracle.AWXML.OlapMeasure

public class OlapMeasure

extends Measure

A Measure resulting from a specific OLAP calculation.

An OlapMeasure can implement the following OLAP DML operations:

   Lead
   Lag 
   Share
   ShareToLevel
   ShareToParent
   PriorPeriod
   PeriodToDate
   SamePeriodAncestorAgo
   MovingSum
   MovingMin
   MovingMax
   MovingAverage
   MovingCount
   

For more information, see the OLAP DML Reference.

See Also:

DerivedMeasure

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

OlapMeasure(BaseObject input)
Creates an OlapMeasure for the specified Measure.

Method Summary

void	addOlapMeasureInput(OlapMeasureInput input) Adds the specified OlapMeasureInput to the OlapMeasure.
java.lang.String	Alter(AWConnection connection) Alters the class attributes of the OlapMeasure in the current analytic workspace of the specified database connection.
java.lang.String	Create(AWConnection connection) Creates an OlapMeasure in the current analytic workspace of the specified database connection.
OlapMeasureInput	createOlapMeasureInput() Creates an OlapMeasureInput for the OlapMeasure.
java.util.Vector	getOlapMeasureInputs() Returns the inputs to the OlapMeasure.
java.lang.String	getOlapOperator() Returns the operator used by the OlapMeasure.
boolean	isValid() Indicates whether the OlapMeasure is a valid object in the analytic workspace.
void	removeOlapMeasureInput(OlapMeasureInput input) Removes the specified OlapMeasureInput from the OlapMeasure.
void	setOlapOperator(java.lang.String input) Sets the operator used by the OlapMeasure.
java.lang.String	WriteToXML() Returns the OlapMeasure as an XML string.

Methods inherited from class oracle.AWXML.Measure

Delete, getAutoSolve, getDataType, getSolveDefinition, setAutoSolve, setDataType, setSolveDefinition

Methods inherited from class oracle.AWXML.BaseObject

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

OlapMeasure

public OlapMeasure(BaseObject input)

Creates an OlapMeasure for the specified Measure.

Parameters:

input - The Measure that owns the OlapMeasure.

Method Detail

setOlapOperator

public void setOlapOperator(java.lang.String input)

Sets the operator used by the OlapMeasure.

Operators are:

   Add
   Subtract
   Multiply
   Divide
   Power
   

Parameters:

input - The name of the operator.

getOlapOperator

public java.lang.String getOlapOperator()

Returns the operator used by the OlapMeasure.

Returns:

The name of the operator.

addOlapMeasureInput

public void addOlapMeasureInput(OlapMeasureInput input)

Adds the specified OlapMeasureInput to the OlapMeasure.

Parameters:

input - The OlapMeasureInput to add.

removeOlapMeasureInput

public void removeOlapMeasureInput(OlapMeasureInput input)

Removes the specified OlapMeasureInput from the OlapMeasure.

Parameters:

input - The OlapMeasureInput to remove.

getOlapMeasureInputs

public java.util.Vector getOlapMeasureInputs()

Returns the inputs to the OlapMeasure.

Returns:

A Vector of OlapMeasureInput objects.

createOlapMeasureInput

public OlapMeasureInput createOlapMeasureInput()

Creates an OlapMeasureInput for the OlapMeasure.

Returns:

The new OlapMeasureInput.

WriteToXML

public java.lang.String WriteToXML()

Returns the OlapMeasure as an XML string.

Overrides:

WriteToXML in class Measure

Returns:

A String containing the XML that represents the OlapMeasure.

Create

public java.lang.String Create(AWConnection connection)

Creates an OlapMeasure in the current analytic workspace of the specified database connection.

Overrides:

Create in class Measure

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

"success" if successful.

Alter

public java.lang.String Alter(AWConnection connection)

Alters the class attributes of the OlapMeasure in the current analytic workspace of the specified database connection.

You can use the Alter method to change descriptive names of the object or reset the schema of a top-level object.

To alter the object's structural definition, you must create, modify, or remove its owned objects.

Overrides:

Alter in class Measure

Parameters:

connection - The AWConnection that represents the database connection.

Returns:

"success" if successful.

isValid

public boolean isValid()

Indicates whether the OlapMeasure is a valid object in the analytic workspace.

Returns:

A boolean that is true if the OlapMeasure is valid or false if it is not valid.