Oracle OLAP Analytic Workspace Java API Reference: Class DimensionKeySourceExpression

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 DimensionKeySourceExpression

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.ExternalSourceExpression
              |
              +--oracle.AWXML.RestrictedSourceExpression
                    |
                    +--oracle.AWXML.DimensionKeySourceExpression

public class DimensionKeySourceExpression
extends RestrictedSourceExpression

Specifies the key columns for a dimension, a level, a hierarchy, or a level within a hierarchy.

Fields inherited from class oracle.AWXML.RestrictedSourceExpression

m_restriction

Fields inherited from class oracle.AWXML.ExternalSourceExpression

m_SourceColumn, m_targetObject

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
`DimensionKeySourceExpression(BaseObject input)` Constructor for a `DimensionKeySourceExpression`.

Method Summary
`java.lang.String`	`Alter(AWConnection connection)` Alters a `DimensionKeySourceExpression` in the current analytic workspace.
`java.lang.String`	`Create(AWConnection connection)` Creates a `DimensionKeySourceExpression` in the current analytic workspace.
`java.lang.String`	`Delete(AWConnection connection)` Removes a `DimensionKeySourceExpression` from the current analytic workspace.
`Hierarchy`	`getHierarchy()` Returns the `Hierarchy` that is the target for a set of columns.
`Level`	`getLevel()` Returns the `Level` that is the target for one or more columns.
`void`	`setHierarchy(Hierarchy input)` Sets a `Hierarchy` as the target for a set of columns.
`void`	`setLevel(Level input)` Sets a `Level` as the target object associated with one or more columns
`java.lang.String`	`WriteToXML()` Returns the object as an XML string.

Methods inherited from class oracle.AWXML.RestrictedSourceExpression

createRestriction, getRestriction, getWhereClause, setRestriction, setWhereClause

Methods inherited from class oracle.AWXML.ExternalSourceExpression

addSourceColumn, CreateSourceColumn, getSourceColumns, getTargetObject, removeSourceColumn, setTargetObject

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

DimensionKeySourceExpression

public DimensionKeySourceExpression(BaseObject input)

Constructor for a DimensionKeySourceExpression. Accepts a Dimension, a Level, a Hierarchy, or a HierarchyLevelAssociation as input.

Parameters:: input - BaseObject

Method Detail

setLevel

public void setLevel(Level input)

Sets a Level as the target object associated with one or more columns

Parameters:: input - Level

getLevel

public Level getLevel()

Returns the Level that is the target for one or more columns.

Returns:: Level

setHierarchy

public void setHierarchy(Hierarchy input)

Sets a Hierarchy as the target for a set of columns.

Parameters:: input - Hierarchy

getHierarchy

public Hierarchy getHierarchy()

Returns the Hierarchy that is the target for a set of columns.

Returns:: Hierarchy

WriteToXML

public java.lang.String WriteToXML()

Returns the object as an XML string.

Overrides:: WriteToXML in class RestrictedSourceExpression

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

Create

public java.lang.String Create(AWConnection connection)

Creates a DimensionKeySourceExpression in the current analytic workspace.

Overrides:: Create in class BaseObject

Parameters:: connection - AWConnection through which the command will be processed
Returns:: A String indicating if the call was successful. A successful invocation returns the value 'success'.

Alter

public java.lang.String Alter(AWConnection connection)

Alters a DimensionKeySourceExpression in the current analytic workspace.

Overrides:: Alter in class BaseObject

Parameters:: connection - AWConnection through which the command will be processed
Returns:: A String indicating if the call was successful. A successful invocation returns the value 'success'.

Delete

public java.lang.String Delete(AWConnection connection)

Removes a DimensionKeySourceExpression from the current analytic workspace.

Overrides:: Delete in class BaseObject

Parameters:: connection - AWConnection through which the command will be processed
Returns:: A String indicating if the call was successful. A successful invocation returns the value 'success'.