|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jpox.store.rdbms.key.Key
org.jpox.store.rdbms.key.Index
Representation of an index.
Field Summary | |
protected java.util.List |
columns
Columns that the key relates to. |
protected java.lang.String |
name
Name of the key. |
protected DatastoreContainerObject |
table
Table that the key applies to. |
Constructor Summary | |
Index(CandidateKey ck)
Constructor. |
|
Index(DatastoreContainerObject table,
boolean isUnique,
java.lang.String extendedIndexSettings)
Constructor. |
|
Index(ForeignKey fk)
Constructor. |
Method Summary | |
void |
addDatastoreField(DatastoreField col)
Class to add a column to the key |
protected void |
assertSameDatastoreObject(DatastoreField col)
Utility to assert if the column is for a different table. |
boolean |
equals(java.lang.Object obj)
Equality operator. |
java.lang.String |
getColumnList()
Accessor for the column list |
static java.lang.String |
getColumnList(java.util.Collection cols)
Method to return the list of columns which the key applies to. |
java.util.List |
getColumns()
Accessor for the columns that the key relates to. |
DatastoreContainerObject |
getDatastoreContainerObject()
Accessor for the table |
java.lang.String |
getExtendedIndexSettings()
Extended index settings, mostly datastore proprietary settings |
java.lang.String |
getName()
Accessor for the key name. |
boolean |
getUnique()
Accessor for whether the index is unique |
int |
hashCode()
Hashcode operator. |
void |
setColumn(int seq,
Column col)
Sets a column for in a specified position seq |
protected static void |
setMinSize(java.util.List list,
int size)
|
void |
setName(java.lang.String name)
Mutator for the key name. |
int |
size()
Accessor for the size. |
boolean |
startsWith(org.jpox.store.rdbms.key.Key key)
Check if this starts with the same columns specified in key . |
java.lang.String |
toString()
Stringify method. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
protected java.lang.String name
protected DatastoreContainerObject table
protected java.util.List columns
Constructor Detail |
public Index(DatastoreContainerObject table, boolean isUnique, java.lang.String extendedIndexSettings)
table
- The tableisUnique
- Whether the index is uniqueextendedIndexSettings
- extended index settingspublic Index(CandidateKey ck)
ck
- Candidate key to use as a basispublic Index(ForeignKey fk)
fk
- Foreign key to use as a basisMethod Detail |
public boolean getUnique()
public void setColumn(int seq, Column col)
seq
seq
- the specified position for the col
col
- the Columnpublic int size()
public int hashCode()
public boolean equals(java.lang.Object obj)
obj
- Object to compare against
public java.lang.String getExtendedIndexSettings()
public java.lang.String toString()
public java.lang.String getName()
public DatastoreContainerObject getDatastoreContainerObject()
public java.util.List getColumns()
public java.lang.String getColumnList()
public void addDatastoreField(DatastoreField col)
col
- The column to addpublic boolean startsWith(org.jpox.store.rdbms.key.Key key)
key
.
key
- the Key (may be multiple number of columns)
key
public void setName(java.lang.String name)
name
- The key nameprotected void assertSameDatastoreObject(DatastoreField col)
col
- The column to compare withprotected static void setMinSize(java.util.List list, int size)
public static java.lang.String getColumnList(java.util.Collection cols)
cols
- The columns.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |