Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)

B14351-02

oracle.AWXML
Class DimensionKeySourceExpression

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

public class DimensionKeySourceExpression
extends RestrictedSourceExpression

A column mapping for a Dimension, a Hierarchy, or a Level. The mapping specifies the relational columns that contain the dimension members of the object.

A DimensionKeySourceExpression is owned by a DimensionMapGroup. To create a DimensionKeySourceExpression, use the CreateKeyMap method of the DimensionMapGroup for the Dimension, Hierarchy, or Level.

You can limit the rows in the source columns by using the methods the DimensionKeySourceExpression class inherits from RestrictedSourceExpression.

See Also:
MappingGroup

Fields inherited from class oracle.AWXML.BaseObject
DATABASENULL

 

Constructor Summary
DimensionKeySourceExpression(BaseObject input)
          Creates a DimensionKeySourceExpression for the specified DimensionMapGroup.

 

Method Summary
 java.lang.String Alter(AWConnection connection)
          Alters the textual attributes DimensionKeySourceExpression in the current analytic workspace of the specified database connection.
 java.lang.String Create(AWConnection connection)
          Creates the DimensionKeySourceExpression in the current analytic workspace of the specified database connection.
 java.lang.String Delete(AWConnection connection)
          Deletes the DimensionKeySourceExpression in the current analytic workspace of the specified database connection.
 Hierarchy getHierarchy()
          Gets the Hierarchy that is specified by the DimensionKeySourceExpression.
 Level getLevel()
          Gets the Level that is specified by the DimensionKeySourceExpression.
 void setHierarchy(Hierarchy input)
          Specifies a Hierarchy as the target object to map to the columns.
 void setLevel(Level input)
          Specifies a Level as the target object to map to the columns.
 java.lang.String WriteToXML()
          Gets an XML representation of the DimensionKeySourceExpression.

 

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

DimensionKeySourceExpression

public DimensionKeySourceExpression(BaseObject input)
Creates a DimensionKeySourceExpression for the specified DimensionMapGroup. To create a DimensionKeySourceExpression, an application should use the CreateKeyMap method of the DimensionMapGroup for the Dimension, Hierarchy, or Level.
Parameters:
input - The DimensionMapGroup to own the DimensionKeySourceExpression.

Method Detail

setLevel

public void setLevel(Level input)
Specifies a Level as the target object to map to the columns.
Parameters:
input - The Level that you want to map to the columns.

getLevel

public Level getLevel()
Gets the Level that is specified by the DimensionKeySourceExpression.
Returns:
The Level that is specified by the DimensionKeySourceExpression.

setHierarchy

public void setHierarchy(Hierarchy input)
Specifies a Hierarchy as the target object to map to the columns.
Parameters:
input - The Hierarchy that you want to map to the columns.

getHierarchy

public Hierarchy getHierarchy()
Gets the Hierarchy that is specified by the DimensionKeySourceExpression.
Returns:
The Hierarchy that is specified by the DimensionKeySourceExpression.

WriteToXML

public java.lang.String WriteToXML()
Gets an XML representation of the DimensionKeySourceExpression.
Overrides:
WriteToXML in class RestrictedSourceExpression
Returns:
An XML String that represents the DimensionKeySourceExpression.

Create

public java.lang.String Create(AWConnection connection)
Creates the DimensionKeySourceExpression in the current analytic workspace of the specified database connection. To create a DimensionKeySourceExpression, an application should use the CreateKeyMap method of the DimensionMapGroup for the Dimension, Hierarchy, or Level.
Overrides:
Create in class BaseObject
Parameters:
connection - The AWConnection that represents the database connection.
Returns:
A String that contains Success if the method creates the DimensionKeySourceExpression.

Alter

public java.lang.String Alter(AWConnection connection)
Alters the textual attributes DimensionKeySourceExpression in the current analytic workspace of the specified database connection.
Overrides:
Alter in class BaseObject
Parameters:
connection - The AWConnection that represents the database connection.
Returns:
A String that contains Success if the method alters the DimensionKeySourceExpression.

Delete

public java.lang.String Delete(AWConnection connection)
Deletes the DimensionKeySourceExpression in the current analytic workspace of the specified database connection.
Overrides:
Delete in class BaseObject
Parameters:
connection - The AWConnection that represents the database connection.
Returns:
A String that contains Success if the method deletes the DimensionKeySourceExpression.

Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)

B14351-02

Copyright © 2003, 2005 Oracle. All rights reserved.