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

B14351-01

oracle.AWXML
Class Index

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.Index

public class Index
extends BaseObject

Creates an index for an Attribute, which enables a query to execute more quickly. Creating an Index for an Attribute causes the analytic workspace to implement the Attribute as a RELATION rather than as a VARIABLE.


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 for which you want to create an 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 is 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:
If successful, a String that contains success.

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:
If successful, a String that contains success.

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

B14351-01

Copyright © 2003, 2005 Oracle. All rights reserved.