org.jminor.framework.domain

Enum Entity.KeyGenerator.Type

java.lang.Object

java.lang.Enum<Entity.KeyGenerator.Type>

org.jminor.framework.domain.Entity.KeyGenerator.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Entity.KeyGenerator.Type>

Enclosing interface:

Entity.KeyGenerator

public static enum Entity.KeyGenerator.Type
extends java.lang.Enum<Entity.KeyGenerator.Type>

The possible key generation strategy types

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTOMATIC The primary key value is automatically created by the underlying database or the key generator implementation
INCREMENT The primary key value is generated by incrementing the max value of a column
NONE The primary key is not generated but set manually before insert
QUERY The primary key value is retreived via query before insert
SEQUENCE The primary key value is fetched from a sequence before insert

Method Summary

Modifier and Type	Method and Description
boolean	isAutoIncrement()
boolean	isManual()
static Entity.KeyGenerator.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Entity.KeyGenerator.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final Entity.KeyGenerator.Type NONE

The primary key is not generated but set manually before insert

SEQUENCE

public static final Entity.KeyGenerator.Type SEQUENCE

The primary key value is fetched from a sequence before insert

QUERY

public static final Entity.KeyGenerator.Type QUERY

The primary key value is retreived via query before insert

INCREMENT

public static final Entity.KeyGenerator.Type INCREMENT

The primary key value is generated by incrementing the max value of a column

AUTOMATIC

public static final Entity.KeyGenerator.Type AUTOMATIC

The primary key value is automatically created by the underlying database or the key generator implementation

Method Detail

values

public static Entity.KeyGenerator.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Entity.KeyGenerator.Type c : Entity.KeyGenerator.Type.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Entity.KeyGenerator.Type valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isAutoIncrement

public boolean isAutoIncrement()

Returns:

true if the underlying database handles the key generation, f.ex. with a autoIncrement column or a database trigger

isManual

public boolean isManual()

Returns:

true if the key value needs to be included in the Entity before insert