com.goldencode.p2j.persist.orm.schema.element

Class Index

java.lang.Object

com.goldencode.p2j.persist.orm.schema.element.Element

com.goldencode.p2j.persist.orm.schema.element.Index

public class Index
extends Element

Index representation for database schema storage and comparison.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<Tuple<java.lang.String,java.lang.Boolean>>	columns List of columns the index is attached to.
private boolean	primary Is primary? This property is only mutable because the standard JDBC API does not provide information whether the index is primary.
private boolean	unique Is unique?

Constructor Summary

Constructors

Constructor and Description
Index(java.lang.String name, Table table, boolean unique, boolean primary, java.lang.String comment) Default constructor.
Index(java.lang.String name, Table table, java.util.Collection<Tuple<java.lang.String,java.lang.Boolean>> cols, boolean unique, boolean primary, java.lang.String comment) Second constructor, that allows to fill columns on creation.

Method Summary

Modifier and Type	Method and Description
java.util.List<Tuple<java.lang.String,java.lang.Boolean>>	getColumns() Getter for columns.
boolean	getPrimary() Getter for primary.
boolean	getUnique() Getter for unique.
void	setPrimary(boolean isPrimary) Setter for primary.

Methods inherited from class com.goldencode.p2j.persist.orm.schema.element.Element

equals, getComment, getName, getTable, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

columns

private final java.util.List<Tuple<java.lang.String,java.lang.Boolean>> columns

List of columns the index is attached to. The elements of this list are composed of the column name (as a String and a Boolean representing the sort direction (true is ASCENDING)).

unique

private final boolean unique

Is unique?

primary

private boolean primary

Is primary? This property is only mutable because the standard JDBC API does not provide information whether the index is primary. This information has to be loaded separately and updated later.

Constructor Detail

Index

public Index(java.lang.String name,
             Table table,
             boolean unique,
             boolean primary,
             java.lang.String comment)

Default constructor.

Parameters:

name - Most basic property of any element - its name.

table - Table containing the index (parent).

unique - Is unique?

primary - Is primary?

comment - Comment for the index.

Index

public Index(java.lang.String name,
             Table table,
             java.util.Collection<Tuple<java.lang.String,java.lang.Boolean>> cols,
             boolean unique,
             boolean primary,
             java.lang.String comment)

Second constructor, that allows to fill columns on creation.

Parameters:

name - Most basic property of any element - it's name.

table - Table containing the index (parent).

cols - List of columns the index is attached to. The elements of this list are composed of the column name (as a String and a Boolean representing the sort direction (true is ASCENDING)).

unique - Is unique?

primary - Is primary?

comment - Comment for the index.

Method Detail

getColumns

public java.util.List<Tuple<java.lang.String,java.lang.Boolean>> getColumns()

Getter for columns.

Returns:

List of columns the index is attached to. The elements of this list are composed of the column name (as a String and a Boolean representing the sort direction (true is ASCENDING)).

getUnique

public boolean getUnique()

Getter for unique.

Returns:

Is unique?

getPrimary

public boolean getPrimary()

Getter for primary.

Returns:

Is primary?

setPrimary

public void setPrimary(boolean isPrimary)

Setter for primary.

Parameters:

isPrimary - Is primary?