org.josef.jpa

Class AbstractEntityIdentifiedById

java.lang.Object

org.josef.jpa.AbstractEntity

org.josef.jpa.AbstractEntityIdentifiedById

All Implemented Interfaces:

Serializable, Persistable

Direct Known Subclasses:

AbstractAuditTrailEntityIdentifiedById

@Status(stage=PRODUCTION,
        unitTests=PARTIAL)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
 @MappedSuperclass
public abstract class AbstractEntityIdentifiedById
extends AbstractEntity

Ultimate base class for JPA Entity classes that are identified by an ID.
An ID is normally only unique within the entity and is supposed to act as the "Primary Key". Contrast this with "Object ID's" which are normally unique for all Objects of all types.
It is assumed that the column in the database table that stores the ID, is named "ID". To redefine the column name for the ID field, add the following annotation to your own JPA Entity:
@AttributeOverride(name = "id", column = @Column(name = "KEY"))
This defines that the database column holding the ID is named "KEY" in the database table.

Version:

1.0 $Revision: 5785 $

Author:

Kees Schotanus

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractEntityIdentifiedById() Default constructor as required by JPA specifications.

Method Summary

Modifier and Type	Method and Description
Long	getId() Gets the unique ID of this Entity.
Long	getPrimaryKey() Gets the primary key of this persistable entity.
void	setId(Long id) Sets the unique ID for this Entity.
String	toString() Creates a String representation of this Entity.

Methods inherited from class org.josef.jpa.AbstractEntity

equals, getVersion, hashCode, setVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEntityIdentifiedById

public AbstractEntityIdentifiedById()

Default constructor as required by JPA specifications.
At least for unenhanced entities.

Method Detail

getId

public Long getId()

Gets the unique ID of this Entity.

Returns:

The unique ID of this Entity.

setId

public void setId(Long id)

Sets the unique ID for this Entity.

Parameters:

id - Unique ID.

getPrimaryKey

public Long getPrimaryKey()

Gets the primary key of this persistable entity.

Returns:

The primary key of this persistable entity.

toString

public String toString()

Creates a String representation of this Entity.

Overrides:

toString in class Object

Returns:

A String representation of this Entity.
The returned String consists of the name of the Entity and its ID.