Modifier and Type	Class and Description
public static class	OptimizerFactory.HiLoOptimizer Optimizer which applies a 'hilo' algorithm in memory to achieve optimization.
public static interface	OptimizerFactory.InitialValueAwareOptimizer Marker interface for optimizer which wish to know the user-specified initial value.
public static class	OptimizerFactory.LegacyHiLoAlgorithmOptimizer
public static class	OptimizerFactory.NoopOptimizer An optimizer that performs no optimization.
public abstract static class	OptimizerFactory.OptimizerSupport Common support for optimizer implementations.
public static class	OptimizerFactory.PooledLoOptimizer
public static class	OptimizerFactory.PooledOptimizer Optimizer which uses a pool of values, storing the next low value of the range in the database.
public static enum	OptimizerFactory.StandardOptimizerDescriptor

Modifier and Type	Field and Description
private static Class<T>[]	CTOR_SIG
private static final Logger	log

Access	Constructor and Description
public	OptimizerFactory()

Method Summary

Modifier and Type	Method and Description
private static Optimizer	buildFallbackOptimizer(Class<T> returnClass, int incrementSize)
public static Optimizer	Returns: The built optimizer buildOptimizer(String The optimizer type, either a short-hand name or the `Optimizer` class name. type, Class<T> The generated value java type returnClass, int The increment size. incrementSize) Deprecated Use `buildOptimizer(String, Class, int, long)` instead Builds an optimizer
public static Optimizer	Returns: The built optimizer buildOptimizer(String The optimizer type, either a short-hand name or the `Optimizer` class name. type, Class<T> The generated value java type returnClass, int The increment size. incrementSize, long The user supplied initial-value (-1 indicates the user did not specify). explicitInitialValue) Builds an optimizer
public static boolean	isPooledOptimizer(String type)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

CTOR_SIG	back to summary
private static Class<T>[] CTOR_SIG

log	back to summary
private static final Logger log

Constructor Detail

OptimizerFactory	back to summary
public OptimizerFactory()

Method Detail

buildFallbackOptimizer	back to summary
private static Optimizer buildFallbackOptimizer(Class<T> returnClass, int incrementSize)

buildOptimizer back to summary

buildOptimizer	back to summary
public static Optimizer buildOptimizer(String type, Class<T> returnClass, int incrementSize) Deprecated Use `buildOptimizer(String, Class, int, long)` instead Builds an optimizer Parameters type:String The optimizer type, either a short-hand name or the `Optimizer` class name. returnClass:Class<T> The generated value java type incrementSize:int The increment size. Returns:Optimizer The built optimizer Annotations @SuppressWarnings:UnnecessaryBoxing, unchecked

public static Optimizer buildOptimizer(String type, Class<T> returnClass, int incrementSize)

Deprecated

Use buildOptimizer(String, Class, int, long) instead

Builds an optimizer

Parameters

type:String: The optimizer type, either a short-hand name or the Optimizer class name.
returnClass:Class<T>: The generated value java type
incrementSize:int: The increment size.

Returns:Optimizer

The built optimizer

Annotations

@SuppressWarnings:UnnecessaryBoxing, unchecked

buildOptimizer back to summary

buildOptimizer	back to summary
public static Optimizer buildOptimizer(String type, Class<T> returnClass, int incrementSize, long explicitInitialValue) Builds an optimizer Parameters type:String The optimizer type, either a short-hand name or the `Optimizer` class name. returnClass:Class<T> The generated value java type incrementSize:int The increment size. explicitInitialValue:long The user supplied initial-value (-1 indicates the user did not specify). Returns:Optimizer The built optimizer Annotations @SuppressWarnings:UnnecessaryBoxing, deprecation

public static Optimizer buildOptimizer(String type, Class<T> returnClass, int incrementSize, long explicitInitialValue)

Builds an optimizer

Parameters

type:String: The optimizer type, either a short-hand name or the Optimizer class name.
returnClass:Class<T>: The generated value java type
incrementSize:int: The increment size.
explicitInitialValue:long: The user supplied initial-value (-1 indicates the user did not specify).

Returns:Optimizer

The built optimizer

Annotations

@SuppressWarnings:UnnecessaryBoxing, deprecation

isPooledOptimizer	back to summary
public static boolean isPooledOptimizer(String type)

org.hibernate.id.enhanced back to summary

public Class OptimizerFactory.HiLoOptimizer

Class Inheritance

extends OptimizerSupport

java.lang.Object
org.hibernate.id.enhanced.OptimizerFactory.OptimizerSupport
org.hibernate.id.enhanced.OptimizerFactory.HiLoOptimizer

Optimizer which applies a 'hilo' algorithm in memory to achieve optimization.

A 'hilo' algorithm is simply a means for a single value stored in the database to represent a "bucket" of possible, contiguous values. The database value identifies which particular bucket we are on.

This database value must be paired with another value that defines the size of the bucket; the number of possible values available. The incrementSize serves this purpose. The naming here is meant more for consistency in that this value serves the same purpose as the increment supplied to the PooledOptimizer.

The general algorithms used to determine the bucket are:

upperLimit = (databaseValue * incrementSize) + 1
lowerLimit = upperLimit - 1

As an example, consider a case with incrementSize of 10. Initially the database holds 1:

upperLimit = (1 * 20) + 1 = 21
lowerLimit = 21 - 20 = 1

From there we increment the value from lowerLimit until we reach the upperLimit, at which point we would define a new bucket. The database now contains 2, though incrementSize remains unchanged:

upperLimit = (2 * 20) + 1 = 41
lowerLimit = 41 - 20 = 21

And so on...

Note, 'value' always (after init) holds the next value to return

Field Summary

Modifier and Type	Field and Description
private IntegralDataTypeHolder	lastSourceValue
private IntegralDataTypeHolder	upperLimit
private IntegralDataTypeHolder	value

Inherited from org.hibernate.id.enhanced.OptimizerFactory.OptimizerSupport:: incrementSize returnClass

Constructor Summary

Access	Constructor and Description
public	HiLoOptimizer(Class<T> returnClass, int incrementSize)

Method Summary

Modifier and Type	Method and Description
public boolean	applyIncrementSizeToSourceValues() Implements org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues. Are increments to be applied to the values stored in the underlying value source?
public synchronized Serializable	generate(AccessCallback Callback to access the underlying value source. callback) Implements org.hibernate.id.enhanced.Optimizer.generate. Generate an identifier value accounting for this specific optimization.
public IntegralDataTypeHolder	Returns: Value for property 'upperLimit'. getHiValue() Getter for property 'upperLimit'.
public IntegralDataTypeHolder	getLastSourceValue() Implements org.hibernate.id.enhanced.Optimizer.getLastSourceValue. A common means to access the last value obtained from the underlying source.
public IntegralDataTypeHolder	Returns: Value for property 'lastValue'. getLastValue() Getter for property 'lastValue'.

Inherited from org.hibernate.id.enhanced.OptimizerFactory.OptimizerSupport:: getIncrementSize getReturnClass

Field Detail

lastSourceValue	back to summary
private IntegralDataTypeHolder lastSourceValue

upperLimit	back to summary
private IntegralDataTypeHolder upperLimit

value	back to summary
private IntegralDataTypeHolder value

Constructor Detail

HiLoOptimizer	back to summary
public HiLoOptimizer(Class<T> returnClass, int incrementSize)

Method Detail

applyIncrementSizeToSourceValues	back to summary
public boolean applyIncrementSizeToSourceValues() Implements org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues. Doc from org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues. Are increments to be applied to the values stored in the underlying value source? Returns:boolean 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.

applyIncrementSizeToSourceValues

back to summary

public boolean applyIncrementSizeToSourceValues()

Implements org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues.

Doc from org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues.

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

Returns:boolean: 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.

generate	back to summary
public synchronized Serializable generate(AccessCallback callback) Implements org.hibernate.id.enhanced.Optimizer.generate. Doc from org.hibernate.id.enhanced.Optimizer.generate. Generate an identifier value accounting for this specific optimization. Parameters callback:AccessCallback Callback to access the underlying value source. Returns:Serializable The generated identifier value.

generate

back to summary

public synchronized Serializable generate(AccessCallback callback)

Implements org.hibernate.id.enhanced.Optimizer.generate.

Doc from org.hibernate.id.enhanced.Optimizer.generate.

Generate an identifier value accounting for this specific optimization.

Parameters

callback:AccessCallback: Callback to access the underlying value source.

Returns:Serializable

The generated identifier value.

getHiValue	back to summary
public IntegralDataTypeHolder getHiValue() Getter for property 'upperLimit'. Exposure intended for testing purposes. Returns:IntegralDataTypeHolder Value for property 'upperLimit'.

getHiValue

back to summary

public IntegralDataTypeHolder getHiValue()

Getter for property 'upperLimit'.

Exposure intended for testing purposes.

Returns:IntegralDataTypeHolder: Value for property 'upperLimit'.

getLastSourceValue	back to summary
public IntegralDataTypeHolder getLastSourceValue() Implements org.hibernate.id.enhanced.Optimizer.getLastSourceValue. Doc from org.hibernate.id.enhanced.Optimizer.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:IntegralDataTypeHolder The last value we obtained from the underlying source; null indicates we have not yet consulted with the source.

getLastSourceValue

back to summary

public IntegralDataTypeHolder getLastSourceValue()

Implements org.hibernate.id.enhanced.Optimizer.getLastSourceValue.

Doc from org.hibernate.id.enhanced.Optimizer.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:IntegralDataTypeHolder: The last value we obtained from the underlying source; null indicates we have not yet consulted with the source.

getLastValue	back to summary
public IntegralDataTypeHolder getLastValue() Getter for property 'lastValue'. Exposure intended for testing purposes. Returns:IntegralDataTypeHolder Value for property 'lastValue'.

getLastValue

back to summary

public IntegralDataTypeHolder getLastValue()

Getter for property 'lastValue'.

Exposure intended for testing purposes.

Returns:IntegralDataTypeHolder: Value for property 'lastValue'.

org.hibernate.id.enhanced back to summary

public Interface OptimizerFactory.InitialValueAwareOptimizer

Known Direct Implementers: org.hibernate.id.enhanced.OptimizerFactory.PooledOptimizer

Marker interface for optimizer which wish to know the user-specified initial value.

Used instead of constructor injection since that is already a public understanding and because not all optimizers care.

Method Summary

Modifier and Type	Method and Description
public void	injectInitialValue(long The initial value specified by the user, or `-1` to indicate that the user did not specify. initialValue) Reports the user specified initial value to the optimizer.

Method Detail

injectInitialValue back to summary

injectInitialValue	back to summary
public void injectInitialValue(long initialValue) Reports the user specified initial value to the optimizer. `-1` is used to indicate that the user did not specify. Parameters initialValue:long The initial value specified by the user, or `-1` to indicate that the user did not specify.

public void injectInitialValue(long initialValue)

Reports the user specified initial value to the optimizer.

-1 is used to indicate that the user did not specify.

Parameters

initialValue:long: The initial value specified by the user, or -1 to indicate that the user did not specify.

org.hibernate.id.enhanced back to summary

public Class OptimizerFactory.LegacyHiLoAlgorithmOptimizer

Class Inheritance

extends OptimizerSupport

java.lang.Object
org.hibernate.id.enhanced.OptimizerFactory.OptimizerSupport
org.hibernate.id.enhanced.OptimizerFactory.LegacyHiLoAlgorithmOptimizer

Field Summary

Modifier and Type	Field and Description
private IntegralDataTypeHolder	hi
private IntegralDataTypeHolder	lastSourceValue
private long	lo
private long	maxLo
private IntegralDataTypeHolder	value

Inherited from org.hibernate.id.enhanced.OptimizerFactory.OptimizerSupport:: incrementSize returnClass

Constructor Summary

Access	Constructor and Description
public	LegacyHiLoAlgorithmOptimizer(Class<T> returnClass, int incrementSize)

Method Summary

Modifier and Type	Method and Description
public boolean	applyIncrementSizeToSourceValues() Implements org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues. Are increments to be applied to the values stored in the underlying value source?
public synchronized Serializable	generate(AccessCallback Callback to access the underlying value source. callback) Implements org.hibernate.id.enhanced.Optimizer.generate. Generate an identifier value accounting for this specific optimization.
public IntegralDataTypeHolder	getLastSourceValue() Implements org.hibernate.id.enhanced.Optimizer.getLastSourceValue. A common means to access the last value obtained from the underlying source.
public IntegralDataTypeHolder	Returns: Value for property 'lastValue'. getLastValue() Getter for property 'lastValue'.

Inherited from org.hibernate.id.enhanced.OptimizerFactory.OptimizerSupport:: getIncrementSize getReturnClass

Field Detail

hi	back to summary
private IntegralDataTypeHolder hi

lastSourceValue	back to summary
private IntegralDataTypeHolder lastSourceValue

lo	back to summary
private long lo

maxLo	back to summary
private long maxLo

value	back to summary
private IntegralDataTypeHolder value

Constructor Detail

LegacyHiLoAlgorithmOptimizer	back to summary
public LegacyHiLoAlgorithmOptimizer(Class<T> returnClass, int incrementSize)

Method Detail

applyIncrementSizeToSourceValues	back to summary
public boolean applyIncrementSizeToSourceValues() Implements org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues. Doc from org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues. Are increments to be applied to the values stored in the underlying value source? Returns:boolean 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.

applyIncrementSizeToSourceValues

back to summary

public boolean applyIncrementSizeToSourceValues()

Implements org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues.

Doc from org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues.

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

Returns:boolean: 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.

generate	back to summary
public synchronized Serializable generate(AccessCallback callback) Implements org.hibernate.id.enhanced.Optimizer.generate. Doc from org.hibernate.id.enhanced.Optimizer.generate. Generate an identifier value accounting for this specific optimization. Parameters callback:AccessCallback Callback to access the underlying value source. Returns:Serializable The generated identifier value.

generate

back to summary

public synchronized Serializable generate(AccessCallback callback)

Implements org.hibernate.id.enhanced.Optimizer.generate.

Doc from org.hibernate.id.enhanced.Optimizer.generate.

Generate an identifier value accounting for this specific optimization.

Parameters

callback:AccessCallback: Callback to access the underlying value source.

Returns:Serializable

The generated identifier value.

getLastSourceValue	back to summary
public IntegralDataTypeHolder getLastSourceValue() Implements org.hibernate.id.enhanced.Optimizer.getLastSourceValue. Doc from org.hibernate.id.enhanced.Optimizer.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:IntegralDataTypeHolder The last value we obtained from the underlying source; null indicates we have not yet consulted with the source.

getLastSourceValue

back to summary

public IntegralDataTypeHolder getLastSourceValue()

Implements org.hibernate.id.enhanced.Optimizer.getLastSourceValue.

Doc from org.hibernate.id.enhanced.Optimizer.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:IntegralDataTypeHolder: The last value we obtained from the underlying source; null indicates we have not yet consulted with the source.

getLastValue	back to summary
public IntegralDataTypeHolder getLastValue() Getter for property 'lastValue'. Exposure intended for testing purposes. Returns:IntegralDataTypeHolder Value for property 'lastValue'. Annotations @SuppressWarnings:UnusedDeclaration

getLastValue

back to summary

public IntegralDataTypeHolder getLastValue()

Getter for property 'lastValue'.

Exposure intended for testing purposes.

Returns:IntegralDataTypeHolder

Value for property 'lastValue'.

Annotations

@SuppressWarnings:UnusedDeclaration

org.hibernate.id.enhanced back to summary

public Class OptimizerFactory.NoopOptimizer

Class Inheritance

extends OptimizerSupport

java.lang.Object
org.hibernate.id.enhanced.OptimizerFactory.OptimizerSupport
org.hibernate.id.enhanced.OptimizerFactory.NoopOptimizer

An optimizer that performs no optimization. The database is hit for every request.

Field Summary

Modifier and Type	Field and Description
private IntegralDataTypeHolder	lastSourceValue

Inherited from org.hibernate.id.enhanced.OptimizerFactory.OptimizerSupport:: incrementSize returnClass

Constructor Summary

Access	Constructor and Description
public	NoopOptimizer(Class<T> returnClass, int incrementSize)

Method Summary

Modifier and Type	Method and Description
public boolean	applyIncrementSizeToSourceValues() Implements org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues. Are increments to be applied to the values stored in the underlying value source?
public Serializable	generate(AccessCallback Callback to access the underlying value source. callback) Implements org.hibernate.id.enhanced.Optimizer.generate. Generate an identifier value accounting for this specific optimization.
public IntegralDataTypeHolder	getLastSourceValue() Implements org.hibernate.id.enhanced.Optimizer.getLastSourceValue. A common means to access the last value obtained from the underlying source.

Inherited from org.hibernate.id.enhanced.OptimizerFactory.OptimizerSupport:: getIncrementSize getReturnClass

Field Detail

lastSourceValue	back to summary
private IntegralDataTypeHolder lastSourceValue

Constructor Detail

NoopOptimizer	back to summary
public NoopOptimizer(Class<T> returnClass, int incrementSize)

Method Detail

applyIncrementSizeToSourceValues	back to summary
public boolean applyIncrementSizeToSourceValues() Implements org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues. Doc from org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues. Are increments to be applied to the values stored in the underlying value source? Returns:boolean 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.

applyIncrementSizeToSourceValues

back to summary

public boolean applyIncrementSizeToSourceValues()

Implements org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues.

Doc from org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues.

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

Returns:boolean: 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.

generate	back to summary
public Serializable generate(AccessCallback callback) Implements org.hibernate.id.enhanced.Optimizer.generate. Doc from org.hibernate.id.enhanced.Optimizer.generate. Generate an identifier value accounting for this specific optimization. Parameters callback:AccessCallback Callback to access the underlying value source. Returns:Serializable The generated identifier value.

generate

back to summary

public Serializable generate(AccessCallback callback)

Implements org.hibernate.id.enhanced.Optimizer.generate.

Doc from org.hibernate.id.enhanced.Optimizer.generate.

Generate an identifier value accounting for this specific optimization.

Parameters

callback:AccessCallback: Callback to access the underlying value source.

Returns:Serializable

The generated identifier value.

getLastSourceValue	back to summary
public IntegralDataTypeHolder getLastSourceValue() Implements org.hibernate.id.enhanced.Optimizer.getLastSourceValue. Doc from org.hibernate.id.enhanced.Optimizer.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:IntegralDataTypeHolder The last value we obtained from the underlying source; null indicates we have not yet consulted with the source.

getLastSourceValue

back to summary

public IntegralDataTypeHolder getLastSourceValue()

Implements org.hibernate.id.enhanced.Optimizer.getLastSourceValue.

Doc from org.hibernate.id.enhanced.Optimizer.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:IntegralDataTypeHolder: The last value we obtained from the underlying source; null indicates we have not yet consulted with the source.

org.hibernate.id.enhanced back to summary

public abstract Class OptimizerFactory.OptimizerSupport

Class Inheritance

extends Object
implements Optimizer

java.lang.Object
org.hibernate.id.enhanced.OptimizerFactory.OptimizerSupport

All Implemented Interfaces

org.hibernate.id.enhanced.Optimizer

Known Direct Subclasses

org.hibernate.id.enhanced.OptimizerFactory.NoopOptimizer, org.hibernate.id.enhanced.OptimizerFactory.HiLoOptimizer, org.hibernate.id.enhanced.OptimizerFactory.LegacyHiLoAlgorithmOptimizer, org.hibernate.id.enhanced.OptimizerFactory.PooledOptimizer, org.hibernate.id.enhanced.OptimizerFactory.PooledLoOptimizer

Common support for optimizer implementations.

Field Summary

Modifier and Type	Field and Description
protected final int	incrementSize
protected final Class<T>	returnClass

Constructor Summary

Access	Constructor and Description
protected	OptimizerSupport(Class<T> The expected id class. returnClass, int The increment size incrementSize) Construct an optimizer

Method Summary

Modifier and Type	Method and Description
public final int	getIncrementSize() Implements org.hibernate.id.enhanced.Optimizer.getIncrementSize. Retrieves the defined increment size.
public final Class<T>	Returns: Value for property 'returnClass'. getReturnClass() Getter for property 'returnClass'.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

incrementSize	back to summary
protected final int incrementSize

returnClass	back to summary
protected final Class<T> returnClass

Constructor Detail

OptimizerSupport

back to summary

protected OptimizerSupport(Class<T> returnClass, int incrementSize)

Construct an optimizer

Parameters

returnClass:Class<T>: The expected id class.
incrementSize:int: The increment size

Method Detail

getIncrementSize

back to summary

public final int getIncrementSize()

Implements org.hibernate.id.enhanced.Optimizer.getIncrementSize.

Doc from org.hibernate.id.enhanced.Optimizer.getIncrementSize.

Retrieves the defined increment size.

Returns:int: The increment size.

getReturnClass back to summary

public final Class<T> getReturnClass()

Getter for property 'returnClass'. This is the Java class which is used to represent the id (e.g. java.lang.Long).

Returns:Class<T>

Value for property 'returnClass'.

Annotations

@SuppressWarnings:UnusedDeclaration

org.hibernate.id.enhanced back to summary

public Class OptimizerFactory.PooledLoOptimizer

Class Inheritance

extends OptimizerSupport

java.lang.Object
org.hibernate.id.enhanced.OptimizerFactory.OptimizerSupport
org.hibernate.id.enhanced.OptimizerFactory.PooledLoOptimizer

Field Summary

Modifier and Type	Field and Description
private IntegralDataTypeHolder	lastSourceValue
private IntegralDataTypeHolder	value

Inherited from org.hibernate.id.enhanced.OptimizerFactory.OptimizerSupport:: incrementSize returnClass

Constructor Summary

Access	Constructor and Description
public	PooledLoOptimizer(Class<T> returnClass, int incrementSize)

Method Summary

Modifier and Type	Method and Description
public boolean	applyIncrementSizeToSourceValues() Implements org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues. Are increments to be applied to the values stored in the underlying value source?
public Serializable	generate(AccessCallback Callback to access the underlying value source. callback) Implements org.hibernate.id.enhanced.Optimizer.generate. Generate an identifier value accounting for this specific optimization.
public IntegralDataTypeHolder	getLastSourceValue() Implements org.hibernate.id.enhanced.Optimizer.getLastSourceValue. A common means to access the last value obtained from the underlying source.

Inherited from org.hibernate.id.enhanced.OptimizerFactory.OptimizerSupport:: getIncrementSize getReturnClass

Field Detail

lastSourceValue	back to summary
private IntegralDataTypeHolder lastSourceValue

value	back to summary
private IntegralDataTypeHolder value

Constructor Detail

PooledLoOptimizer	back to summary
public PooledLoOptimizer(Class<T> returnClass, int incrementSize)

Method Detail

applyIncrementSizeToSourceValues

back to summary

public boolean applyIncrementSizeToSourceValues()

Implements org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues.

Doc from org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues.

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

Returns:boolean: 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.

generate

back to summary

public Serializable generate(AccessCallback callback)

Implements org.hibernate.id.enhanced.Optimizer.generate.

Doc from org.hibernate.id.enhanced.Optimizer.generate.

Generate an identifier value accounting for this specific optimization.

Parameters

callback:AccessCallback: Callback to access the underlying value source.

Returns:Serializable

The generated identifier value.

getLastSourceValue

back to summary

public IntegralDataTypeHolder getLastSourceValue()

Implements org.hibernate.id.enhanced.Optimizer.getLastSourceValue.

Doc from org.hibernate.id.enhanced.Optimizer.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:IntegralDataTypeHolder: The last value we obtained from the underlying source; null indicates we have not yet consulted with the source.

org.hibernate.id.enhanced back to summary

public Class OptimizerFactory.PooledOptimizer

Class Inheritance

extends OptimizerSupport
implements InitialValueAwareOptimizer

java.lang.Object
org.hibernate.id.enhanced.OptimizerFactory.OptimizerSupport
org.hibernate.id.enhanced.OptimizerFactory.PooledOptimizer

All Implemented Interfaces

org.hibernate.id.enhanced.OptimizerFactory.InitialValueAwareOptimizer

Optimizer which uses a pool of values, storing the next low value of the range in the database.

Note that this optimizer works essentially the same as the HiLoOptimizer except that here the bucket ranges are actually encoded into the database structures.

Note if you prefer that the database value be interpreted as the bottom end of our current range, then use the PooledLoOptimizer strategy

Field Summary

Modifier and Type	Field and Description
private IntegralDataTypeHolder	hiValue
private long	initialValue
private IntegralDataTypeHolder	value

Inherited from org.hibernate.id.enhanced.OptimizerFactory.OptimizerSupport:: incrementSize returnClass

Constructor Summary

Access	Constructor and Description
public	PooledOptimizer(Class<T> returnClass, int incrementSize)

Method Summary

Modifier and Type	Method and Description
public boolean	applyIncrementSizeToSourceValues() Implements org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues. Are increments to be applied to the values stored in the underlying value source?
public synchronized Serializable	generate(AccessCallback Callback to access the underlying value source. callback) Implements org.hibernate.id.enhanced.Optimizer.generate. Generate an identifier value accounting for this specific optimization.
public IntegralDataTypeHolder	getLastSourceValue() Implements org.hibernate.id.enhanced.Optimizer.getLastSourceValue. A common means to access the last value obtained from the underlying source.
public IntegralDataTypeHolder	Returns: Value for property 'lastValue'. getLastValue() Getter for property 'lastValue'.
public void	injectInitialValue(long The initial value specified by the user, or `-1` to indicate that the user did not specify. initialValue) Implements org.hibernate.id.enhanced.OptimizerFactory.InitialValueAwareOptimizer.injectInitialValue. Reports the user specified initial value to the optimizer.

Inherited from org.hibernate.id.enhanced.OptimizerFactory.OptimizerSupport:: getIncrementSize getReturnClass

Field Detail

hiValue	back to summary
private IntegralDataTypeHolder hiValue

initialValue	back to summary
private long initialValue

value	back to summary
private IntegralDataTypeHolder value

Constructor Detail

PooledOptimizer	back to summary
public PooledOptimizer(Class<T> returnClass, int incrementSize)

Method Detail

applyIncrementSizeToSourceValues

back to summary

public boolean applyIncrementSizeToSourceValues()

Implements org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues.

Doc from org.hibernate.id.enhanced.Optimizer.applyIncrementSizeToSourceValues.

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

Returns:boolean: 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.

generate

back to summary

public synchronized Serializable generate(AccessCallback callback)

Implements org.hibernate.id.enhanced.Optimizer.generate.

Doc from org.hibernate.id.enhanced.Optimizer.generate.

Generate an identifier value accounting for this specific optimization.

Parameters

callback:AccessCallback: Callback to access the underlying value source.

Returns:Serializable

The generated identifier value.

getLastSourceValue

back to summary

public IntegralDataTypeHolder getLastSourceValue()

Implements org.hibernate.id.enhanced.Optimizer.getLastSourceValue.

Doc from org.hibernate.id.enhanced.Optimizer.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:IntegralDataTypeHolder: The last value we obtained from the underlying source; null indicates we have not yet consulted with the source.

getLastValue

back to summary

public IntegralDataTypeHolder getLastValue()

Getter for property 'lastValue'.

Exposure intended for testing purposes.

Returns:IntegralDataTypeHolder: Value for property 'lastValue'.

injectInitialValue back to summary

public void injectInitialValue(long initialValue)

Implements org.hibernate.id.enhanced.OptimizerFactory.InitialValueAwareOptimizer.injectInitialValue.

Doc from org.hibernate.id.enhanced.OptimizerFactory.InitialValueAwareOptimizer.injectInitialValue.

Reports the user specified initial value to the optimizer.

-1 is used to indicate that the user did not specify.

Parameters

initialValue:long: The initial value specified by the user, or -1 to indicate that the user did not specify.

org.hibernate.id.enhanced back to summary

public final Enum OptimizerFactory.StandardOptimizerDescriptor

Class Inheritance

extends Enum<OptimizerFactory.StandardOptimizerDescriptor>

java.lang.Object
java.lang.Enum
org.hibernate.id.enhanced.OptimizerFactory.StandardOptimizerDescriptor

Field Summary

Modifier and Type	Field and Description
private final String	externalName
public static final OptimizerFactory.StandardOptimizerDescriptor	HILO
private final boolean	isPooled
public static final OptimizerFactory.StandardOptimizerDescriptor	LEGACY_HILO
public static final OptimizerFactory.StandardOptimizerDescriptor	NONE
private final Class<? extends Optimizer>	optimizerClass
public static final OptimizerFactory.StandardOptimizerDescriptor	POOLED
public static final OptimizerFactory.StandardOptimizerDescriptor	POOLED_LO

Constructor Summary

Access	Constructor and Description
private	StandardOptimizerDescriptor(String externalName, Class<? extends Optimizer> optimizerClass)
private	StandardOptimizerDescriptor(String externalName, Class<? extends Optimizer> optimizerClass, boolean pooled)

Method Summary

Modifier and Type	Method and Description
public static OptimizerFactory.StandardOptimizerDescriptor	fromExternalName(String externalName)
public String	getExternalName()
public Class<? extends Optimizer>	getOptimizerClass()
public boolean	isPooled()
public static OptimizerFactory.StandardOptimizerDescriptor	valueOf(String name)
public static OptimizerFactory.StandardOptimizerDescriptor[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

externalName	back to summary
private final String externalName

HILO	back to summary
public static final OptimizerFactory.StandardOptimizerDescriptor HILO

isPooled	back to summary
private final boolean isPooled

LEGACY_HILO	back to summary
public static final OptimizerFactory.StandardOptimizerDescriptor LEGACY_HILO

NONE	back to summary
public static final OptimizerFactory.StandardOptimizerDescriptor NONE

optimizerClass	back to summary
private final Class<? extends Optimizer> optimizerClass

POOLED	back to summary
public static final OptimizerFactory.StandardOptimizerDescriptor POOLED

POOLED_LO	back to summary
public static final OptimizerFactory.StandardOptimizerDescriptor POOLED_LO

Constructor Detail

StandardOptimizerDescriptor	back to summary
private StandardOptimizerDescriptor(String externalName, Class<? extends Optimizer> optimizerClass)

StandardOptimizerDescriptor	back to summary
private StandardOptimizerDescriptor(String externalName, Class<? extends Optimizer> optimizerClass, boolean pooled)

Method Detail

fromExternalName	back to summary
public static OptimizerFactory.StandardOptimizerDescriptor fromExternalName(String externalName)

getExternalName	back to summary
public String getExternalName()

getOptimizerClass	back to summary
public Class<? extends Optimizer> getOptimizerClass()

isPooled	back to summary
public boolean isPooled()

valueOf	back to summary
public static OptimizerFactory.StandardOptimizerDescriptor valueOf(String name)

values	back to summary
public static OptimizerFactory.StandardOptimizerDescriptor[] values()

public Class OptimizerFactory

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class OptimizerFactory.HiLoOptimizer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface OptimizerFactory.InitialValueAwareOptimizer

Method Summary

Method Detail

public Class OptimizerFactory.LegacyHiLoAlgorithmOptimizer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class OptimizerFactory.NoopOptimizer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class OptimizerFactory.OptimizerSupport

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class OptimizerFactory.PooledLoOptimizer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class OptimizerFactory.PooledOptimizer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum OptimizerFactory.StandardOptimizerDescriptor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail