com.jdc.rdb.sql.ddl.clause
Class Index

java.lang.Object
  |
  +--com.jdc.lang.Object
        |
        +--com.jdc.rdb.sql.SQLClause
              |
              +--com.jdc.rdb.sql.ddl.DDLClause
                    |
                    +--com.jdc.rdb.sql.ddl.clause.Index

All Implemented Interfaces:

Clause, CreateClause, DropClause, Serializable

public class Index

extends DDLClause

implements CreateClause, DropClause

Index represents a Create or Drop SQL statement INDEX clause. The INDEX clause identifies the index object for a Create or Drop operation. The name must identify a Database Index.

Reference:

IBM® DB2 Universal Database™ SQL Reference Volume 2 Version 8, Pages 268 and 518.

Version:

2.0

Author:

Jay Damon

See Also:

Create, Drop, Serialized Form

Field Summary

Fields inherited from class com.jdc.lang.Object

string

Constructor Summary

Index()
Constructs a new Index clause object.

Index(String name)
Constructs a new Index clause object for the specified Database Index name.

Method Summary

String	getKeyword() Returns the Index clause keyword.
String	getValue() Returns the Index clause value.
Index	setName(String name) Sets the Database Index name.
String	toString() Returns a String representation of this Index clause.

Methods inherited from class com.jdc.rdb.sql.ddl.DDLClause

getKeyword

Methods inherited from class com.jdc.rdb.sql.SQLClause

contains, setKeyword, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

Index

public Index()

Constructs a new Index clause object.

Index

public Index(String name)

Constructs a new Index clause object for the specified Database Index name.

Throws:

SQLInvalidException - No INDEX clause name is specified.

See Also:

setName(String)

Method Detail

getKeyword

public String getKeyword()

Returns the Index clause keyword.

Overrides:

getKeyword in class SQLClause

Returns:

The Index clause keyword.

getValue

public String getValue()

Returns the Index clause value.

Overrides:

getValue in class SQLClause

Returns:

The Index clause value.

setName

public Index setName(String name)

Sets the Database Index name.

Returns:

This Index clause object.

Throws:

SQLInvalidException - No index name is specified.

toString

public String toString()

Returns a String representation of this Index clause.

Specified by:

toString in interface CreateClause

Overrides:

toString in class SQLClause

Returns:

A String representation of this Index clause.