public interface

Optimizer

org.hibernate.id.enhanced.Optimizer
Known Indirect Subclasses

Class Overview

Performs optimization on an optimizable identifier generator. Typically this optimization takes the form of trying to ensure we do not have to hit the database on each and every request to get an identifier value.

Optimizers work on constructor injection. They should provide a constructor with the following arguments

  1. java.lang.Class - The return type for the generated values
  2. int - The increment size

Summary

Public Methods
abstract boolean applyIncrementSizeToSourceValues()
Are increments to be applied to the values stored in the underlying value source?
abstract Serializable generate(AccessCallback callback)
Generate an identifier value accounting for this specific optimization.
abstract int getIncrementSize()
Retrieves the defined increment size.
abstract IntegralDataTypeHolder getLastSourceValue()
A common means to access the last value obtained from the underlying source.

Public Methods

public abstract boolean applyIncrementSizeToSourceValues ()

Are increments to be applied to the values stored in the underlying value source?

Returns
  • True if the values in the source are to be incremented according to the defined increment size; false otherwise, in which case the increment is totally an in memory construct.

public abstract Serializable generate (AccessCallback callback)

Generate an identifier value accounting for this specific optimization.

Parameters
callback Callback to access the underlying value source.
Returns
  • The generated identifier value.

public abstract int getIncrementSize ()

Retrieves the defined increment size.

Returns
  • The increment size.

public abstract IntegralDataTypeHolder getLastSourceValue ()

A common means to access the last value obtained from the underlying source. This is intended for testing purposes, since accessing the underlying database source directly is much more difficult.

Returns
  • The last value we obtained from the underlying source; null indicates we have not yet consulted with the source.