Oracle OLAP Analytic Workspace Java API Reference: Class OlapMeasure

Overview

Package

Class

Tree

Deprecated

Index

Help

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

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.AWXML
Class OlapMeasure

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

public class OlapMeasure
extends Measure

An OLAP measure is a derived measure that implements a specific OLAP operation. OLAP measures can implement the following:

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

For more information, see the OLAP DML Reference.

Fields inherited from class oracle.AWXML.Measure

m_dataType

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

Method Summary
`void`	`addOlapMeasureInput(OlapMeasureInput input)` Adds input to the OLAP measure.
`java.lang.String`	`Alter(AWConnection connection)` Alters an `OlapMeasure` in the analytic workspace.
`java.lang.String`	`Create(AWConnection connection)` Creates an `OlapMeasure` in the analytic workspace.
`OlapMeasureInput`	`createOlapMeasureInput()` Creates a new input to the OLAP measure.
`java.util.Vector`	`getOlapMeasureInputs()` Returns a list of the inputs to this OLAP measure.
`java.lang.String`	`getOlapOperator()` Returns the `Operator` for the derived measure.
`void`	`removeOlapMeasureInput(OlapMeasureInput input)` Removes input from the OLAP measure.
`void`	`setOlapOperator(java.lang.String input)` Sets the `Operator` for the derived measure to the specified string.
`java.lang.String`	`WriteToXML()` Returns the object 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, getId, getLongName, getName, getOwner, getParentId, 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

Constructor Detail

OlapMeasure

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

setOlapOperator

public void setOlapOperator(java.lang.String input)

Sets the Operator for the derived measure to the specified string. Operators are:

   Add
   Subtract
   Multiply
   Divide
   Power

Parameters:: input - String specifying the operator

getOlapOperator

public java.lang.String getOlapOperator()

Returns the Operator for the derived measure.

Returns:: String specifying the operator

addOlapMeasureInput

public void addOlapMeasureInput(OlapMeasureInput input)

Adds input to the OLAP measure.

Parameters:: input - OlapMeasureInput

removeOlapMeasureInput

public void removeOlapMeasureInput(OlapMeasureInput input)

Removes input from the OLAP measure.

Parameters:: input - OlapMeasureInput

getOlapMeasureInputs

public java.util.Vector getOlapMeasureInputs()

Returns a list of the inputs to this OLAP measure.

Returns:: Vector containing the inputs

createOlapMeasureInput

public OlapMeasureInput createOlapMeasureInput()

Creates a new input to the OLAP measure.

Returns:: OlapMeasureInput

WriteToXML

public java.lang.String WriteToXML()

Returns the object as an XML string.

Overrides:: WriteToXML in class Measure

Returns:: A String containing the XML that represents the object

Create

public java.lang.String Create(AWConnection connection)

Creates an OlapMeasure in the analytic workspace.

Overrides:: Create in class Measure

Parameters:: connection - AWConnection
Returns:: String containing "success" if successful

Alter

public java.lang.String Alter(AWConnection connection)

Alters an OlapMeasure in the analytic workspace.

Overrides:: Alter in class BaseObject

Parameters:: connection - AWConnection
Returns:: String containing "success" if successful