org.hrorm

Interface PrimaryKey<ENTITY,BUILDER>

Type Parameters:

ENTITY - The type of the entity being represented

BUILDER - The type of the class that can construct new ENTITY instances

All Superinterfaces:

Column<Long,Long,ENTITY,BUILDER>

All Known Implementing Classes:

DirectPrimaryKey, IndirectPrimaryKey

public interface PrimaryKey<ENTITY,BUILDER>
extends Column<Long,Long,ENTITY,BUILDER>

Representation of the column that holds the primary key for the entity.

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

Method Summary

Modifier and Type	Method and Description
Long	getKey(ENTITY item) Reads the value of the primary key from the passed entity object.
default long	getKeyPrimitive(ENTITY item) Reads the value of the primary key from the passed entity object.
String	getSequenceName() The name of the database sequence that is used to populate this key
void	optimisticSetKey(ENTITY item, Long id) Sets the key onto the object

Methods inherited from interface org.hrorm.Column

asGenericColumn, fromResultSet, getName, getPrefix, getSqlTypeName, isNullable, isParentColumn, isPrimaryKey, notNull, populate, setSqlTypeName, setValue, supportedTypes, toClassType, withPrefix

Method Detail

optimisticSetKey

void optimisticSetKey(ENTITY 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

getKey

Long getKey(ENTITY item)

Reads the value of the primary key from the passed entity object.

Parameters:

item - The object whose primary key is to be read.

Returns:

The primary key, or null.

getSequenceName

String getSequenceName()

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

Returns:

the sequence name

getKeyPrimitive

default long getKeyPrimitive(ENTITY item)

Reads the value of the primary key from the passed entity object. Will throw a NullPointerException if the key has not been set.

Parameters:

item - The object whose primary key is to be read.

Returns:

The primary key.