oracle.AWXML
Class OlapMeasureInput

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

public class OlapMeasureInput

extends BaseObject

Input used by an OLAP measure. Refer to the OLAP DML Reference for the arguments of each of the operations supported by OLAP measures.

OLAP measures can implement the following:

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

See Also:

OlapMeasure

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

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

Method Summary

java.lang.String	getKeyWord() Returns an argument keyword to the operation implemented by the OLAP measure.
BaseObject	getReferencedObj() Returns an object referenced by the OLAP measure.
java.lang.String	getScalarValue() Returns a scalar value used as input to the OLAP measure.
void	setKeyWord(java.lang.String input) Sets an argument keyword to the specified string.
void	setReferencedObj(BaseObject input) Specifies an object to be referenced by the OLAP measure.
void	setScalarValue(java.lang.String input) Sets an input scalar value to the specified string.
java.lang.String	WriteToXML() Returns the OlapMeasureInput as an XML string.

Methods inherited from class oracle.AWXML.BaseObject

Alter, Create, CreateAfter, CreateBefore, CreateFirst, DataRead, Delete, 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

OlapMeasureInput

public OlapMeasureInput(BaseObject input)

Creates an OlapMeasureInput for the specified OlapMeasure.

Parameters:

input - The OlapMeasure that owns the OlapMeasureInput.

Method Detail

setKeyWord

public void setKeyWord(java.lang.String input)

Sets an argument keyword to the specified string. Argument keywords are described in the OLAP DML Reference.

Parameters:

input - A String specifying the keyword.

getKeyWord

public java.lang.String getKeyWord()

Returns an argument keyword to the operation implemented by the OLAP measure.

Returns:

A String specifying the keyword.

getScalarValue

public java.lang.String getScalarValue()

Returns a scalar value used as input to the OLAP measure.

Returns:

A String containing the scalar input value.

setScalarValue

public void setScalarValue(java.lang.String input)

Sets an input scalar value to the specified string.

Parameters:

input - A String containing the scalar input value.

setReferencedObj

public void setReferencedObj(BaseObject input)

Specifies an object to be referenced by the OLAP measure.

Parameters:

input - The BaseObject to reference.

getReferencedObj

public BaseObject getReferencedObj()

Returns an object referenced by the OLAP measure.

Returns:

The referenced BaseObject.

WriteToXML

public java.lang.String WriteToXML()

Returns the OlapMeasureInput as an XML string.

Overrides:

WriteToXML in class BaseObject

Returns:

A String containing the XML that represents the OlapMeasureInput.