Class TemporalCollectionKey

java.lang.Object

org.hibernate.engine.spi.CollectionKey

org.hibernate.engine.spi.TemporalCollectionKey

All Implemented Interfaces:

Serializable

public final class TemporalCollectionKey
extends CollectionKey

A CollectionKey for a temporal (historical) snapshot of a collection, loaded from an audit table at a specific changeset identifier.

The changeset identifier is included in equals()/hashCode() so that the persistence context naturally isolates collections at different points in time.

Since:

7.4

See Also:

• CollectionKey
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TemporalCollectionKey(CollectionPersister persister, Object key, Object changesetId)	Construct a unique identifier for a temporal snapshot of a collection.

Method Summary

Modifier and Type	Method	Description
Object	getChangesetId()	The audit changeset identifier for this key, or null for non-temporal collections.
boolean	isTemporal()	Whether this key refers to a temporal (historical) collection snapshot.
String	toString()

Methods inherited from class CollectionKey

deserialize, equals, getKey, getRole, hashCode, serialize

Methods inherited from class Object

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

Constructor Details

TemporalCollectionKey

public TemporalCollectionKey(CollectionPersister persister,
 Object key,
 Object changesetId)

Construct a unique identifier for a temporal snapshot of a collection.

Parameters:

persister - The collection persister

key - The collection key (owner FK)

changesetId - The changeset identifier (must not be null)

Method Details

getChangesetId

public Object getChangesetId()

Description copied from class: CollectionKey

The audit changeset identifier for this key, or null for non-temporal collections.

Overrides:

getChangesetId in class CollectionKey

isTemporal

public boolean isTemporal()

Description copied from class: CollectionKey

Whether this key refers to a temporal (historical) collection snapshot.

Overrides:

isTemporal in class CollectionKey

toString

public String toString()

Overrides:

toString in class CollectionKey