org.josef.jpa

Class AbstractEntityIdentifiedByObjectId

java.lang.Object

org.josef.jpa.AbstractEntity

org.josef.jpa.AbstractEntityIdentifiedByObjectId

All Implemented Interfaces:

Serializable, Persistable

Direct Known Subclasses:

AbstractAuditTrailEntityIdentifiedByObjectId, Car, CarDetail

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

Ultimate base class for JPA Entities that are identified by an Object ID.
An Object ID is normally unique over all Objects (of all types). It is assumed that the column in the database table that stores the Object ID, is named "OID". To redefine the column name for the Object ID field, add the following annotation to your own JPA Entity:
@AttributeOverride(name = "objectId", column = @Column(name = "OBJECT_ID"))
This defines that the database column holding the Object ID is named "OBJECT_ID" in the database table.

Version:

1.0 $Revision: 5785 $

Author:

Kees Schotanus

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Long	getObjectId() Gets the unique Object ID of this Entity.
Long	getPrimaryKey() Gets the primary key of this persistable entity.
void	setObjectId(Long objectId) Sets the unique Object 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

AbstractEntityIdentifiedByObjectId

public AbstractEntityIdentifiedByObjectId()

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

Method Detail

getObjectId

public Long getObjectId()

Gets the unique Object ID of this Entity.

Returns:

The unique Object ID of this Entity.

setObjectId

public void setObjectId(Long objectId)

Sets the unique Object ID for this Entity.
The Object ID is auto-generated and should not be used directly since it could compromise the uniqueness of the Object ID.

Parameters:

objectId - Unique Object 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 Object ID.