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

B14351-04

oracle.AWXML
Class Index

java.lang.Object
  extended byoracle.AWXML.BaseObject
      extended byoracle.AWXML.Index

public class Index
extends BaseObject

Creates an index for an Attribute of a Dimension, which enables a query to execute more quickly. An Index is owned by a Dimension. The Dimension can have only one Index for an individual Attribute.


Field Summary
 
Fields inherited from class oracle.AWXML.BaseObject
DATABASENULL
 
Constructor Summary
Index(BaseObject owner)
          Creates an Index for the Dimension that owns the Attribute.
 
Method Summary
 java.lang.String Create(AWConnection connection)
          Creates the Index in the current analytic workspace.
 java.lang.String Delete(AWConnection connection)
          Removes the Index from the current analytic workspace.
 Attribute getAttribute()
          Gets the Attribute to which the Index applies.
 void setAttribute(Attribute input)
          Specifies the Attribute to which the Index applies.
 java.lang.String WriteToXML()
          Gets an XML representation of the Index.
 
Methods inherited from class oracle.AWXML.BaseObject
Alter, 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

Index

public Index(BaseObject owner)
Creates an Index for the Dimension that owns the Attribute.

Parameters:
owner - The Dimension to own the Index.
Method Detail

setAttribute

public void setAttribute(Attribute input)
Specifies the Attribute to which the Index applies.

Parameters:
input - The Attribute to which the Index applies.

getAttribute

public Attribute getAttribute()
Gets the Attribute to which the Index applies.

Returns:
The Attribute to which the Index applies.

WriteToXML

public java.lang.String WriteToXML()
Gets an XML representation of the Index.

Overrides:
WriteToXML in class BaseObject
Returns:
A String that contains an XML representation of the Index.

Create

public java.lang.String Create(AWConnection connection)
Creates the Index in the current analytic workspace.

Overrides:
Create in class BaseObject
Parameters:
connection - The AWConnection that specifies the database connection.
Returns:
A String that contains Success if this method creates the Index.

Delete

public java.lang.String Delete(AWConnection connection)
Removes the Index from the current analytic workspace.

Overrides:
Delete in class BaseObject
Parameters:
connection - The AWConnection that specifies the database connection.
Returns:
A String that contains Success if this method removes the Index.

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

B14351-04

Copyright © 2003, 2007 Oracle. All rights reserved.