xdev.db

Class Index

java.lang.Object

xdev.db.Index

All Implemented Interfaces:

Serializable, Cloneable, Copyable<Index>

public class Index
extends Object
implements Copyable<Index>, Serializable

This class represents a index.

It has properties like name, type and columns.

Author:

XDEV Software

See Also:

DBMetaData, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Index.IndexType A enumeration generally used for typify the Index.

Constructor Summary

Constructors

Constructor and Description
Index(String name, Index.IndexType type, String... columns) Construct a new Index and initialize this with the name, type and columns.

Method Summary

Modifier and Type	Method and Description
Index	clone() Returns a field-for-field copy of this instance.
boolean	containsColumn(String name) Returns true if this Index contains the specified column.
boolean	equals(Object obj)
String[]	getColumns() Returns the type of this Index.
String	getName() Returns the name of this Index.
Index.IndexType	getType() Returns the type of this Index.
int	hashCode()
boolean	isUnique() Returns true if this Index is a unique index.
void	setColumns(String[] columns) Sets the columns for this Index.
void	setName(String name) Sets the name for this Index.
void	setType(Index.IndexType type) Sets the Index.IndexType for this Index.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Index

public Index(String name,
             Index.IndexType type,
             String... columns)

Construct a new Index and initialize this with the name, type and columns.

Parameters:

name - the name of this Index

type - to typify this Index

columns - the columns on which the Index is

See Also:

Index.IndexType

Method Detail

setName

public void setName(String name)

Sets the name for this Index.

Parameters:

name - the new name

getName

public String getName()

Returns the name of this Index.

Returns:

the name of this Index

setType

public void setType(Index.IndexType type)

Sets the Index.IndexType for this Index.

Parameters:

type - the type for this Index. One of the following constants defined in IndexType:

• NORMAL
• UNIQUE
• PRIMARY_KEY

getType

public Index.IndexType getType()

Returns the type of this Index.

Returns:

the Index.IndexType of this Index

setColumns

public void setColumns(String[] columns)

Sets the columns for this Index.

Parameters:

columns - an array of strings with the columns

getColumns

public String[] getColumns()

Returns the type of this Index.

Returns:

a array of strings including the columns.

containsColumn

public boolean containsColumn(String name)

Returns true if this Index contains the specified column.

Parameters:

name - the column name

Returns:

true if this Index contains the specified column, otherwise false

isUnique

public boolean isUnique()

Returns true if this Index is a unique index.

Returns:

true if this Index is unique, otherwise false

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Index clone()

Returns a field-for-field copy of this instance.

Specified by:

clone in interface Copyable<Index>

Overrides:

clone in class Object

Returns:

a field-for-field copy of this instance.