sirius.db.jdbc.schema

Class Key

java.lang.Object

sirius.db.jdbc.schema.Key

public class Key
extends Object

Represents a database key or index.

Constructor Summary

Constructors

Constructor and Description
Key()

Method Summary

Modifier and Type	Method and Description
void	addColumn(int pos, String field) Adds a column to the key
boolean	equals(Object obj)
List<String>	getColumns() Returns the columns that make up the key.
String	getName() Returns the name of the key.
int	hashCode()
boolean	isUnique() Determines if this key also enforces an unique constraint
void	setName(String name) Sets the name of the key.
void	setUnique(boolean unique) Sets the unique flag.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Key

public Key()

Method Detail

getName

public String getName()

Returns the name of the key.

Returns:

the name of the key

setName

public void setName(String name)

Sets the name of the key.

Parameters:

name - then name of the key

getColumns

public List<String> getColumns()

Returns the columns that make up the key.

Returns:

the columns of the key

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

addColumn

public void addColumn(int pos,
                      String field)

Adds a column to the key

Parameters:

pos - the position to add at

field - the field or column to add

isUnique

public boolean isUnique()

Determines if this key also enforces an unique constraint

Returns:

true if the values in the indexed columns have to be unique, false otherwise

setUnique

public void setUnique(boolean unique)

Sets the unique flag.

Parameters:

unique - true to enforce an unique constraint, false otherwise