Oracle OLAP Analytic Workspace Java API Reference: Class OlapMeasureInput

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 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

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

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 object as an XML string.

Methods inherited from class oracle.AWXML.BaseObject

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

OlapMeasureInput

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

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 - String specifying the keyword

getKeyWord

public java.lang.String getKeyWord()

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

Returns:: String specifying the keyword

getScalarValue

public java.lang.String getScalarValue()

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

Returns:: String containing the scalar input value

setScalarValue

public void setScalarValue(java.lang.String input)

Sets an input scalar value to the specified string.

Returns:: String containing the scalar input value

setReferencedObj

public void setReferencedObj(BaseObject input)

Specifies an object to be referenced by the OLAP measure.

Parameters:: BaseObjectString -

getReferencedObj

public BaseObject getReferencedObj()

Returns an object referenced by the OLAP measure.

Returns:: BaseObjectString

WriteToXML

public java.lang.String WriteToXML()

Returns the object as an XML string.

Overrides:: WriteToXML in class BaseObject

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