au.com.cybersearch2.classyjpa.persist

Interface PersistenceAdmin

All Superinterfaces:

ConnectionSourceFactory

All Known Implementing Classes:

PersistenceAdminImpl

public interface PersistenceAdmin
extends ConnectionSourceFactory

PersistenceAdmin Interface for JPA Support

Author:

Andrew Bowley 05/07/2014

Method Summary

Methods

Modifier and Type	Method and Description
void	addNamedQuery(Class<?> clazz, String name, DaoQueryFactory daoQueryFactory) Add named query to persistence unit context
void	addNamedQuery(String name, QueryInfo queryInfo, SqlQueryFactory queryGenerator) Add native named query to persistence unit context
void	close() Close all database connections
EntityManagerLite	createEntityManager(com.j256.ormlite.support.ConnectionSource connectionSource) Create a EntityManager bound to an existing connectionSource.
String	getDatabaseName() Returns database name
com.j256.ormlite.db.DatabaseType	getDatabaseType() Returns database type
int	getDatabaseVersion()
EntityManagerLiteFactory	getEntityManagerFactory() Returns EntityManager Factory for this perisistence unit
Properties	getProperties() Returns PU properties
List<Object>	getResultList(QueryInfo queryInfo, int startPosition, int maxResults) Returns list of objects from executing a native query
Object	getSingleResult(QueryInfo queryInfo) Returns object from executing a native query
boolean	isSingleConnection() Flag set true if connection source is for a single connection
void	registerClasses(List<String> managedClassNames)

Methods inherited from interface au.com.cybersearch2.classyjpa.persist.ConnectionSourceFactory

getConnectionSource

Method Detail

addNamedQuery

void addNamedQuery(Class<?> clazz,
                 String name,
                 DaoQueryFactory daoQueryFactory)

Add named query to persistence unit context

Parameters:

clazz - Entity class

name - Query name

daoQueryFactory - Query generator

addNamedQuery

void addNamedQuery(String name,
                 QueryInfo queryInfo,
                 SqlQueryFactory queryGenerator)

Add native named query to persistence unit context

Parameters:

name - Query name

queryInfo - Native query information

queryGenerator - Native query generator

getEntityManagerFactory

EntityManagerLiteFactory getEntityManagerFactory()

Returns EntityManager Factory for this perisistence unit

Returns:

EntityManagerLiteFactory

getResultList

List<Object> getResultList(QueryInfo queryInfo,
                         int startPosition,
                         int maxResults)

Returns list of objects from executing a native query

Parameters:

queryInfo - Native query details

startPosition - The start position of the first result, numbered from 0

maxResults - Maximum number of results to retrieve, or 0 for no limit

Returns:

List<Object>

getSingleResult

Object getSingleResult(QueryInfo queryInfo)

Returns object from executing a native query

Parameters:

queryInfo - Native query details

Returns:

Object or null if nothing returned by query

getDatabaseName

String getDatabaseName()

Returns database name

Returns:

String

close

void close()

Close all database connections

getDatabaseType

com.j256.ormlite.db.DatabaseType getDatabaseType()

Returns database type

Returns:

com.j256.ormlite.db.DatabaseType

getDatabaseVersion

int getDatabaseVersion()

getProperties

Properties getProperties()

Returns PU properties

Returns:

java.util.Properties

registerClasses

void registerClasses(List<String> managedClassNames)

createEntityManager

EntityManagerLite createEntityManager(com.j256.ormlite.support.ConnectionSource connectionSource)

Create a EntityManager bound to an existing connectionSource. Use only for special case of database creation or update.

Parameters:

connectionSource - The existing ConnectionSource object

Returns:

Eentity manager instance

isSingleConnection

boolean isSingleConnection()

Flag set true if connection source is for a single connection