Oracle OLAP Analytic Workspace Java API Reference: Class BaseOperator

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 BaseOperator

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.AggregationOperator
              |
              +--oracle.AWXML.BaseOperator

public class BaseOperator
extends AggregationOperator

The operators that can be used for aggregating or allocating data over a dimension. The BaseOperator class provides the valid operators that can be specified for an AggregationOperator. The aggregation operator is used by an Aggregation object, which represents a RELATION statement in the aggregation map.

In the OLAP DML, the operators are:

   AVERAGE
   FIRST
   HAVERAGE
   HFIRST
   HLAST
   HWAVERAGE
   HWFIRST
   HWLAST
   LAST
   MIN
   MAX
   NOAGG
   SSUM
   SUM
   WAVERAGE
   WFIRST
   WLAST
   WSUM

For more information about aggregation operators in analytic workspaces, see "RELATION (for aggregation)" in the OLAP DML Reference.

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

Method Summary
`java.lang.String`	`getOpcode()` Returns the opcode as a string.
`OperatorType`	`getOperatorType()` Returns `OperatorType` which is a type of operator used in allocation.
`static boolean`	`isBaseOperator(java.lang.String input)` Whether or not the operator is a valid operator used by the OLAP DML for aggregation or allocation.
`void`	`setOpcode(java.lang.String input)` Sets the opcode to any operator used by the OLAP DML for aggregating or allocating data over a dimension.
`void`	`setOperatorType(OperatorType input)` Sets the type of the operator to `OperatorType`, which can be any of the operator types used in allocation.
`java.lang.String`	`toString()` Returns the opcode as a 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, wait, wait, wait

Constructor Detail

BaseOperator

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

WriteToXML

public java.lang.String WriteToXML()

Returns the object as an XML string.

Overrides:: WriteToXML in class AggregationOperator

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

setOperatorType

public void setOperatorType(OperatorType input)

Sets the type of the operator to OperatorType, which can be any of the operator types used in allocation.

Parameters:: input - OperatorType

getOperatorType

public OperatorType getOperatorType()

Returns OperatorType which is a type of operator used in allocation.

Returns:: OperatorType

getOpcode

public java.lang.String getOpcode()

Returns the opcode as a string. The opcode is any operator used by the OLAP DML for aggregating or allocating data over a dimension.

Overrides:: getOpcode in class AggregationOperator

Returns:: String

setOpcode

public void setOpcode(java.lang.String input)

Sets the opcode to any operator used by the OLAP DML for aggregating or allocating data over a dimension.

Valid opcodes are:

   AVERAGE
   FIRST
   HAVERAGE
   HFIRST
   HLAST
   HWAVERAGE
   HWFIRST
   HWLAST
   LAST
   MIN
   MAX
   NOAGG
   SSUM
   SUM
   WAVERAGE
   WFIRST
   WLAST
   WSUM

Parameters:: input - String containing the opcode

isBaseOperator

public static boolean isBaseOperator(java.lang.String input)

Whether or not the operator is a valid operator used by the OLAP DML for aggregation or allocation.

Parameters:: input - String containing the opcode
Returns:: boolean

toString

public java.lang.String toString()

Returns the opcode as a string.

Overrides:: toString in class BaseObject

Returns:: String