public class OrmHandler extends Object implements OrmHandlerProvider
| Constructor and Description |
|---|
OrmHandler()
The constructor
|
OrmHandler(Class<UJO>... databaseModels)
The constructor with a database metamodel initialization.
|
OrmHandler(Class<UJO> databaseModel)
The constructor with a database metamodel initialization.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addColumnModel(MetaRelation2Many column)
Map a property to the table
|
void |
addProcedureModel(MetaProcedure metaProcedure)
Map a property to the table
|
void |
addTableModel(MetaTable metaTable)
Map a property to the table
|
<UJO extends OrmUjo> |
alias(Class<UJO> entity,
String alias)
Create new Alias table
|
void |
config(MetaParams params)
Save the ORM parameters.
|
void |
config(MetaRoot config)
Save the alternative ORM configuration including parameters (if the parameters are not null).
|
boolean |
config(String url)
Load parameters from an external XML file.
|
boolean |
config(URL url,
boolean throwsException)
Load parameters from an external XML file.
|
Session |
createSession()
Create new session
|
<T extends Annotation> |
findAnnotation(Key property,
Class<T> annotationClass)
Find a property annotation by the required type.
|
<T extends MetaRelation2Many> |
findColumnModel(Key pathProperty)
Find a Relation/Column model of the paramemeter property.
|
<T extends MetaRelation2Many> |
findColumnModel(Key pathProperty,
boolean throwException)
Find a Relation/Column model of the paramemeter property.
|
MetaProcedure |
findProcedureModel(Class<? extends DbProcedure> procedureClass)
Find a procedure model by the procedureClass.
|
List<Key> |
findPropertiesByType(Class type)
Find all persistent keys with the required type or subtype.
|
MetaTable |
findTableModel(Class<? extends OrmUjo> dbClass)
Find a table model by the dbClass.
|
String |
getConfig()
Returns a final meta-model in the XML format
|
List<MetaDatabase> |
getDatabases()
Returns all database
|
Session |
getDefaultSession()
Get a default Session of the OrmHandler.
|
OrmHandler |
getOrmHandler()
Returns the same instance
|
MetaParams |
getParameters()
Returns parameters
|
Session |
getSession()
Deprecated.
Method was replaced by the name
getDefaultSession() |
boolean |
isDatabaseLoaded()
Returns true, if a database meta-model is loaded.
|
boolean |
isPersistent(Key property)
Is the parameter a persistent property?
|
boolean |
isReadOnly()
Do the handler have a read-only state?
|
<UJO extends OrmUjo> |
loadDatabase(Class<UJO>... databaseModel)
Load a meta-data, lock it and create database tables.
|
<UJO extends OrmUjo> |
loadDatabase(Class<UJO> databaseModel)
Load a meta-data, lock it and create database tables.
|
public OrmHandler()
public OrmHandler(Class<UJO> databaseModel)
public OrmHandler(Class<UJO>... databaseModels)
public Session getDefaultSession()
createSession() rather.createSession()public Session getSession()
getDefaultSession()createSession() rather.createSession()public Session createSession()
public boolean config(String url) throws IllegalArgumentException
IllegalArgumentExceptionpublic void config(MetaParams params) throws IllegalArgumentException
IllegalArgumentExceptionpublic void config(MetaRoot config) throws IllegalArgumentException
IllegalArgumentExceptionpublic boolean config(URL url, boolean throwsException) throws IllegalArgumentException
IllegalArgumentExceptionpublic boolean isPersistent(Key property)
public final <UJO extends OrmUjo> void loadDatabase(Class<UJO> databaseModel)
public final <UJO extends OrmUjo> void loadDatabase(Class<UJO>... databaseModel)
public boolean isReadOnly()
public void addProcedureModel(MetaProcedure metaProcedure)
public void addTableModel(MetaTable metaTable)
public void addColumnModel(MetaRelation2Many column)
public <T extends Annotation> T findAnnotation(Key property, Class<T> annotationClass)
public final <T extends MetaRelation2Many> T findColumnModel(Key pathProperty)
MetaColumn.pathProperty - Parameter can be type of Key of CompositeKey (direct or indirect);MetaColumn for database column
or a related model type of MetaRelation2Many
or the NULL if no model was found.public <T extends MetaRelation2Many> T findColumnModel(Key pathProperty, boolean throwException) throws IllegalArgumentException
MetaColumn.pathProperty - Parameter can be type of Property of CompositeKey (direct or indirect);throwException - Throw the IllegalArgument exception of no Model was not foundMetaColumn for database column
or a related model type of MetaRelation2Many
or the NULL if no model was found.IllegalArgumentExceptionpublic MetaTable findTableModel(Class<? extends OrmUjo> dbClass) throws IllegalStateException
IllegalStateExceptionpublic MetaProcedure findProcedureModel(Class<? extends DbProcedure> procedureClass) throws IllegalStateException
IllegalStateExceptionpublic MetaParams getParameters()
public boolean isDatabaseLoaded()
public List<MetaDatabase> getDatabases()
public List<Key> findPropertiesByType(Class type)
type - The parameter value Object.clas returns all persistent keys.public String getConfig()
public OrmHandler getOrmHandler()
getOrmHandler in interface OrmHandlerProviderpublic <UJO extends OrmUjo> AliasTable<UJO> alias(Class<UJO> entity, String alias)
Copyright 2013, Pavel Ponec