Module org.datanucleus.store.rdbms

Package org.datanucleus.store.rdbms.key

Class Index

java.lang.Object

org.datanucleus.store.rdbms.key.ColumnOrderedKey

org.datanucleus.store.rdbms.key.Index

public class Index
extends ColumnOrderedKey

Representation of an INDEX.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Column>	columns	Columns that the key relates to.
static String	EXTENSION_INDEX_EXTENDED_SETTING
static String	EXTENSION_INDEX_TYPE
protected String	name	Name of the key.
protected Table	table	Table that the key applies to.

Fields inherited from class org.datanucleus.store.rdbms.key.ColumnOrderedKey

columnOrdering, extensions

Constructor Summary

Constructors

Constructor	Description
Index(CandidateKey ck)	Constructor for an index for the specified candidate key.
Index(ForeignKey fk)	Constructor for an index for the specified foreign key.
Index(Table table, boolean isUnique, Map<String,String> extensions)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	assertSameDatastoreObject(Column col)	Utility to assert if the column is for a different table.
boolean	equals(Object obj)	Equality operator.
String	getColumnList()	Accessor for the column list
static String	getColumnList(List<Column> cols)	Method to return the list of columns which the key applies to.
List<Column>	getColumns()	Accessor for the columns that the key relates to.
String	getName()	Accessor for the key name.
int	getNumberOfColumns()	Accessor for the number of columns.
Table	getTable()	Accessor for the table
boolean	getUnique()	Accessor for whether the index is unique
int	hashCode()	Hashcode operator.
protected static void	setListMinimumSize(List<?> list, int size)
void	setName(String name)	Mutator for the key name.
String	toString()	Stringify method.

Methods inherited from class org.datanucleus.store.rdbms.key.ColumnOrderedKey

addColumn, getColumnList, getValueForExtension, setColumn, setColumnOrdering

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION_INDEX_EXTENDED_SETTING

public static final String EXTENSION_INDEX_EXTENDED_SETTING

See Also:

Constant Field Values

EXTENSION_INDEX_TYPE

public static final String EXTENSION_INDEX_TYPE

See Also:

Constant Field Values

name

protected String name

Name of the key.

table

protected Table table

Table that the key applies to.

columns

protected List<Column> columns

Columns that the key relates to.

Constructor Detail

Index

public Index(Table table,
             boolean isUnique,
             Map<String,String> extensions)

Constructor.

Parameters:

table - The table

isUnique - Whether the index is unique

extensions - Any extensions for the index

Index

public Index(CandidateKey ck)

Constructor for an index for the specified candidate key.

Parameters:

ck - Candidate key to use as a basis

Index

public Index(ForeignKey fk)

Constructor for an index for the specified foreign key.

Parameters:

fk - Foreign key to use as a basis

Method Detail

getUnique

public boolean getUnique()

Accessor for whether the index is unique

Returns:

Whether it is unique.

hashCode

public int hashCode()

Hashcode operator.

Returns:

The hashcode

equals

public boolean equals(Object obj)

Equality operator.

Parameters:

obj - Object to compare against

Returns:

Whether they are equal.

toString

public String toString()

Stringify method. Generates a form of the index ready to be used in a DDL statement. e.g

INDEX (col1, col2)

Overrides:

toString in class Object

Returns:

String version of this object.

setName

public void setName(String name)

Mutator for the key name.

Parameters:

name - The key name

getName

public String getName()

Accessor for the key name.

Returns:

Key name

getTable

public Table getTable()

Accessor for the table

Returns:

table

getColumns

public List<Column> getColumns()

Accessor for the columns that the key relates to.

Returns:

the List of columns.

getColumnList

public String getColumnList()

Accessor for the column list

Returns:

The column list

getNumberOfColumns

public int getNumberOfColumns()

Accessor for the number of columns.

Returns:

The number of columns.

assertSameDatastoreObject

protected void assertSameDatastoreObject(Column col)

Utility to assert if the column is for a different table.

Parameters:

col - The column to compare with

setListMinimumSize

protected static void setListMinimumSize(List<?> list,
                                         int size)

getColumnList

public static String getColumnList(List<Column> cols)

Method to return the list of columns which the key applies to.

Parameters:

cols - The columns.

Returns:

The column list.