org.hrorm

Interface PrimaryKey<T>

Type Parameters:

T - The entity represented by this key.

All Superinterfaces:

TypedColumn<T>

All Known Implementing Classes:

PrimaryKeyImpl

public interface PrimaryKey<T>
extends TypedColumn<T>

Representation of a primary key of an entity.

Most users of hrorm will have no need to directly use this.

Method Summary

Modifier and Type	Method and Description
Long	getKey(T item) Extracts the primary key
String	getSequenceName() The name of the database sequence that is used to populate this key
void	setKey(T item, Long id) Sets the key onto the object

Methods inherited from interface org.hrorm.TypedColumn

getName, getPrefix, isPrimaryKey, notNull, populate, setValue, withPrefix

Method Detail

getKey

Long getKey(T item)

Extracts the primary key

Parameters:

item - The object whose key is to be extracted

Returns:

the primary key

getSequenceName

String getSequenceName()

The name of the database sequence that is used to populate this key

Returns:

the sequence name

setKey

void setKey(T item,
            Long id)

Sets the key onto the object

Parameters:

item - the object whose key is to be set

id - the primary key to assign it