jodd.db.oom

Class DbEntityManager

java.lang.Object

jodd.db.oom.DbEntityManager

public class DbEntityManager
extends java.lang.Object

DbOom Entity manager.

Important: configure settings before entity registration!

Mapping definitions are used only by a result set mapper (such as ResultSetMapper) to lookup for an entity from table name. Table names are read from result-set meta data, for example. It is not needed to use mappings at all: in that case just provide entity types during the conversion of result set to objects.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Class,DbEntityDescriptor>	descriptorsMap
protected java.util.Map<java.lang.String,DbEntityDescriptor>	entityNamesMap
protected java.lang.String[]	primitiveEntitiesPrefixes
protected java.util.Map<java.lang.String,DbEntityDescriptor>	tableNamesMap

Constructor Summary

Constructors

Constructor and Description
DbEntityManager()

Method Summary

Modifier and Type	Method and Description
protected <E> DbEntityDescriptor<E>	createDbEntityDescriptor(java.lang.Class<E> type) Creates DbEntityDescriptor.
<E> E	createEntityInstance(java.lang.Class<E> type) Creates new entity instances.
static DbEntityManager	get() Returns default instance.
java.lang.String[]	getPrimitiveEntitiesPrefixes()
int	getTotalNames() Returns total number of registered entity names.
int	getTotalTableNames() Returns total number of registered table names.
int	getTotalTypes() Returns total number of registered types.
boolean	isRegistered(java.lang.Class type) Returns true if type is registered withing manager.
DbEntityDescriptor	lookupName(java.lang.String typeName) Lookups for DbEntityDescriptor that was registered with this manager.
DbEntityDescriptor	lookupTableName(java.lang.String tableName) Lookups for DbEntityDescriptor that was registered with this manager.
<E> DbEntityDescriptor<E>	lookupType(java.lang.Class<E> type) Lookups DbEntityDescriptor for some type and registers the type if is new.
<E> DbEntityDescriptor<E>	registerEntity(java.lang.Class<E> type) Registers entity.
<E> DbEntityDescriptor<E>	registerEntity(java.lang.Class<E> type, boolean force) Registers entity.
<E> DbEntityDescriptor<E>	registerType(java.lang.Class<E> type) Registers just type and entity names.
<E> DbEntityDescriptor<E>	removeEntity(java.lang.Class<E> type) Removes entity and returns removed descriptor.
void	reset() Resets the manager and clears descriptors maps.
void	setPrimitiveEntitiesPrefixes(java.lang.String... primitiveEntitiesPrefixes) Specifies array of class name prefixes that will be mapped directly to column.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

primitiveEntitiesPrefixes

protected java.lang.String[] primitiveEntitiesPrefixes

descriptorsMap

protected java.util.Map<java.lang.Class,DbEntityDescriptor> descriptorsMap

entityNamesMap

protected java.util.Map<java.lang.String,DbEntityDescriptor> entityNamesMap

tableNamesMap

protected java.util.Map<java.lang.String,DbEntityDescriptor> tableNamesMap

Constructor Detail

DbEntityManager

public DbEntityManager()

Method Detail

get

public static DbEntityManager get()

Returns default instance.

getPrimitiveEntitiesPrefixes

public java.lang.String[] getPrimitiveEntitiesPrefixes()

setPrimitiveEntitiesPrefixes

public void setPrimitiveEntitiesPrefixes(java.lang.String... primitiveEntitiesPrefixes)

Specifies array of class name prefixes that will be mapped directly to column.

lookupType

public <E> DbEntityDescriptor<E> lookupType(java.lang.Class<E> type)

Lookups DbEntityDescriptor for some type and registers the type if is new.

Returns null for core classes from java run-time packages! Some types are not entities, i.e. domain objects. Instead, primitive entities are simply mapped to one column.

isRegistered

public boolean isRegistered(java.lang.Class type)

Returns true if type is registered withing manager.

lookupName

public DbEntityDescriptor lookupName(java.lang.String typeName)

Lookups for DbEntityDescriptor that was registered with this manager. Returns null if name not found.

lookupTableName

public DbEntityDescriptor lookupTableName(java.lang.String tableName)

Lookups for DbEntityDescriptor that was registered with this manager. Returns null if table name not found. Lookup is case-insensitive.

registerType

public <E> DbEntityDescriptor<E> registerType(java.lang.Class<E> type)

Registers just type and entity names. Enough for most usages.

registerEntity

public <E> DbEntityDescriptor<E> registerEntity(java.lang.Class<E> type)

Registers entity. Registers types and table names.

registerEntity

public <E> DbEntityDescriptor<E> registerEntity(java.lang.Class<E> type,
                                                boolean force)

Registers entity. Existing entity will be removed if exist, so no exception will be thrown.

removeEntity

public <E> DbEntityDescriptor<E> removeEntity(java.lang.Class<E> type)

Removes entity and returns removed descriptor.

createDbEntityDescriptor

protected <E> DbEntityDescriptor<E> createDbEntityDescriptor(java.lang.Class<E> type)

Creates DbEntityDescriptor.

getTotalNames

public int getTotalNames()

Returns total number of registered entity names.

getTotalTableNames

public int getTotalTableNames()

Returns total number of registered table names.

getTotalTypes

public int getTotalTypes()

Returns total number of registered types.

reset

public void reset()

Resets the manager and clears descriptors maps.

createEntityInstance

public <E> E createEntityInstance(java.lang.Class<E> type)

Creates new entity instances.