oracle.ifs.common

Class IndexSpecification

java.lang.Object

oracle.ifs.common.IndexSpecification

All Implemented Interfaces:

Serializable

public class IndexSpecification
extends Object
implements Serializable

A IndexSpecification represents a database index. Users can specify the name, list of columns, uniquenes and partitioning attributes for the index. For partitioned classes, if partitioning is set to true, a partition prefixed local index is created.

The default behavior is to create a non-unique non partitioned index.

Version:

1.0

Author:

Harish Butani

See Also:

Serialized Form

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	m_Columns The columns of the index
protected boolean	m_IsPartitioned Is the index partitioned.
protected boolean	m_IsUnique Is the index unique.
protected String	m_Name The index name

Constructor Summary

Constructors

Constructor and Description
IndexSpecification() default constructor.
IndexSpecification(String name, String[] columns)
IndexSpecification(String name, String[] columns, boolean isUniq, boolean isPartitioned)

Method Summary

Modifier and Type	Method and Description
String[]	getColumns()
String	getCreateStatement(String tableName, boolean tabIsPartitioned)
String	getName()
boolean	isPartitioned()
boolean	isUnique()
void	setColumns(String[] columns)
void	setName(String name)
void	setPartitioned(boolean partition)
void	setUnique(boolean uniq)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_Columns

protected String[] m_Columns

The columns of the index

m_Name

protected String m_Name

The index name

m_IsUnique

protected boolean m_IsUnique

Is the index unique. Deafult is false

m_IsPartitioned

protected boolean m_IsPartitioned

Is the index partitioned. For partitioned tables, a Local prefixed index is created, if set to true. A non-partitioned index is created if set to false. For non-partitioned tables, the option is ignored. Default is false.

Constructor Detail

IndexSpecification

public IndexSpecification()
                   throws IfsException

default constructor.

Throws:

IfsException

IndexSpecification

public IndexSpecification(String name,
                          String[] columns)
                   throws IfsException

Throws:

IfsException

IndexSpecification

public IndexSpecification(String name,
                          String[] columns,
                          boolean isUniq,
                          boolean isPartitioned)
                   throws IfsException

Throws:

IfsException

Method Detail

getName

public String getName()

setName

public void setName(String name)
             throws IfsException

Throws:

IfsException

getColumns

public String[] getColumns()

setColumns

public void setColumns(String[] columns)
                throws IfsException

Throws:

IfsException

isUnique

public boolean isUnique()

setUnique

public void setUnique(boolean uniq)

isPartitioned

public boolean isPartitioned()

setPartitioned

public void setPartitioned(boolean partition)

getCreateStatement

public String getCreateStatement(String tableName,
                                 boolean tabIsPartitioned)
                          throws IfsException

Throws:

IfsException