org.opengts.dbtools
Class DBAlternateIndex

java.lang.Object
  org.opengts.dbtools.DBAlternateIndex

public class DBAlternateIndex
extends java.lang.Object

DBAlternateIndex holds information for a single defined alternate index.

Constructor Summary

DBAlternateIndex(DBFactory factory, java.lang.String indexName)
Constructor

Method Summary

void	addField(DBField field) Adds the specified field to this index
boolean	equals(java.lang.Object other) Returns true if the specified Object is equivalent to this DBAlternativeIndex
DBFactory	getFactory() Gets the DBFactory instance
java.lang.String	getFieldNames() Returns a String list of comma-separated field names
DBField[]	getFields() Returns an array of DBFields for this index
java.lang.String	getIndexName() Gets the index name
java.lang.String	getUntranslatedTableName() Returns the table name
boolean	isUnique() Returns true if the index is unique
java.lang.String	toString() Returns a String representation of this DBAlternateIndex

Methods inherited from class java.lang.Object

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

Constructor Detail

DBAlternateIndex

public DBAlternateIndex(DBFactory factory,
                        java.lang.String indexName)

Constructor

Parameters:

factory - The DBFactory instance

indexName - The index name

Method Detail

getFactory

public DBFactory getFactory()

Gets the DBFactory instance

Returns:

The DBFactory instance

getUntranslatedTableName

public java.lang.String getUntranslatedTableName()

Returns the table name

Returns:

The table name

getIndexName

public java.lang.String getIndexName()

Gets the index name

Returns:

The index name

isUnique

public boolean isUnique()

Returns true if the index is unique

Returns:

True if the index is unique

addField

public void addField(DBField field)

Adds the specified field to this index

Parameters:

field - The DBField to add

getFields

public DBField[] getFields()

Returns an array of DBFields for this index

Returns:

An array of DBFields for this index

getFieldNames

public java.lang.String getFieldNames()

Returns a String list of comma-separated field names

Returns:

A String containing a comma-separated list of field names

toString

public java.lang.String toString()

Returns a String representation of this DBAlternateIndex

Overrides:

toString in class java.lang.Object

Returns:

A String representation of this DBAlternateIndex

equals

public boolean equals(java.lang.Object other)

Returns true if the specified Object is equivalent to this DBAlternativeIndex

Overrides:

equals in class java.lang.Object

Parameters:

other - The other Object

Returns:

True if the specified Object is equivalent to this DBAlternativeIndex