com.metamatrix.common.jdbc.metadata
Class IndexType

java.lang.Object
  com.metamatrix.common.jdbc.metadata.IndexType

public class IndexType
extends java.lang.Object

Field Summary

static IndexType	CLUSTERED Identifies an index as a clustered index.
static IndexType	HASHED Identifies an index as a hashed index.
static IndexType	OTHER Identifies an index as some other style of index.
static IndexType	STATISTIC Identifies table statistics that are returned in conjunction with a table's index descriptions.

Method Summary

int	compareTo(java.lang.Object obj) Compares this object to another.
boolean	equals(java.lang.Object obj) Returns true if the specified object is semantically equal to this instance.
java.lang.String	getDisplayName() Return the display name for this type.
static IndexType	getInstance(int value)
static IndexType	getInstance(java.lang.String displayName)
int	hashCode() Returns the hash code value for this object.
java.lang.String	toString() Returns a string representing the current state of the object.

Methods inherited from class java.lang.Object

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

Field Detail

STATISTIC

public static final IndexType STATISTIC

Identifies table statistics that are returned in conjunction with a table's index descriptions.

CLUSTERED

public static final IndexType CLUSTERED

Identifies an index as a clustered index.

HASHED

public static final IndexType HASHED

Identifies an index as a hashed index.

OTHER

public static final IndexType OTHER

Identifies an index as some other style of index.

Method Detail

getInstance

public static IndexType getInstance(java.lang.String displayName)

getInstance

public static IndexType getInstance(int value)

getDisplayName

public java.lang.String getDisplayName()

Return the display name for this type.

Returns:

the display name

compareTo

public int compareTo(java.lang.Object obj)

Compares this object to another. If the specified object is an instance of the MetaMatrixSessionID class, then this method compares the contents; otherwise, it throws a ClassCastException (as instances are comparable only to instances of the same class).

Note: this method is consistent with equals(), meaning that (compare(x, y)==0) == (x.equals(y)).

Parameters:

obj - the object that this instance is to be compared to.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object, respectively.

Throws:

java.lang.IllegalArgumentException - if the specified object reference is null

java.lang.ClassCastException - if the specified object's type prevents it from being compared to this instance.

equals

public boolean equals(java.lang.Object obj)

Returns true if the specified object is semantically equal to this instance. Note: this method is consistent with compareTo().

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object that this instance is to be compared to.

Returns:

whether the object is equal to this object.

hashCode

public final int hashCode()

Returns the hash code value for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.

toString

public final java.lang.String toString()

Returns a string representing the current state of the object.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of this instance.