uk.ac.ed.epcc.webapp.jdbc.table

Class DataBaseHandlerService

java.lang.Object

uk.ac.ed.epcc.webapp.jdbc.table.DataBaseHandlerService

All Implemented Interfaces:

AppContextCleanup, AppContextService<DataBaseHandlerService>, Contexed

public class DataBaseHandlerService
extends java.lang.Object
implements Contexed, AppContextService<DataBaseHandlerService>

Handler class for database level (as opposed to table level) operations Currently this implementation is tied to MySQL. Make this class abstract and introduce a sub-type to work with other DB implementations.

Field Summary

Fields

Modifier and Type	Field and Description
static Feature	CLEAR_DATABASE
static Feature	COMMIT_ON_CREATE
static java.lang.String	NO_PROPS_ATTR

Constructor Summary

Constructors

Constructor and Description
DataBaseHandlerService(AppContext c)

Method Summary

Modifier and Type	Method and Description
java.lang.String	alterTableText(Repository res, TableSpecification s, SQLContext c, java.util.List<java.lang.Object> args) produce the SQL to create a table.
void	cleanup() AppContext is being closed.
void	clearDatabase()
void	createTable(java.lang.String name, TableSpecification orig) Create a database table based on a TableSpecification The TableSpecification can be augmented by properties starting with create_table.table-name using {@link TableSpecification#setFromParameters(AppContext, String, java.util.Map).
java.lang.String	createTableText(boolean check_exists, java.lang.String name, TableSpecification s, SQLContext c, java.util.List<java.lang.Object> args)
java.lang.String	createTableText(java.lang.String name, TableSpecification s, SQLContext c, java.util.List<java.lang.Object> args) produce the SQL to create a table.
void	deleteTable(java.lang.String name)
AppContext	getContext()
java.util.Set<java.lang.String>	getTables() Get a Set of all known table names.
java.lang.Class<? super DataBaseHandlerService>	getType() Returns the type of service the class should be registered under.
protected java.lang.String	rename(java.lang.String name, java.lang.String s2)
boolean	tableExists(java.lang.String name)
void	updateTable(Repository res, TableSpecification orig)

Methods inherited from class java.lang.Object

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

Field Detail

CLEAR_DATABASE

public static final Feature CLEAR_DATABASE

COMMIT_ON_CREATE

public static final Feature COMMIT_ON_CREATE

NO_PROPS_ATTR

public static final java.lang.String NO_PROPS_ATTR

See Also:

Constant Field Values

Constructor Detail

DataBaseHandlerService

public DataBaseHandlerService(AppContext c)

Method Detail

getContext

public AppContext getContext()

Specified by:

getContext in interface Contexed

tableExists

public boolean tableExists(java.lang.String name)

getTables

public java.util.Set<java.lang.String> getTables()
                                          throws DataException

Get a Set of all known table names.

Returns:

Set

Throws:

DataException

createTable

public void createTable(java.lang.String name,
                        TableSpecification orig)
                 throws DataFault

Create a database table based on a TableSpecification The TableSpecification can be augmented by properties starting with create_table.table-name using TableSpecification#setFromParameters(AppContext, String, java.util.Map). In addition fields can be renamed by setting create_table.rename_field.table.field=new-field This is usually only necessary for unit tests and will have to be combined with rename.new-field=field so the {@link Repository} maps the field back to the expected name.

Parameters:

name -

orig -

Throws:

DataFault

createTableText

public java.lang.String createTableText(java.lang.String name,
                                        TableSpecification s,
                                        SQLContext c,
                                        java.util.List<java.lang.Object> args)

produce the SQL to create a table.

Parameters:

name -

s -

c -

args -

Returns:

createTableText

public java.lang.String createTableText(boolean check_exists,
                                        java.lang.String name,
                                        TableSpecification s,
                                        SQLContext c,
                                        java.util.List<java.lang.Object> args)

rename

protected java.lang.String rename(java.lang.String name,
                                  java.lang.String s2)

updateTable

public void updateTable(Repository res,
                        TableSpecification orig)
                 throws DataFault

Throws:

DataFault

alterTableText

public java.lang.String alterTableText(Repository res,
                                       TableSpecification s,
                                       SQLContext c,
                                       java.util.List<java.lang.Object> args)

produce the SQL to create a table.

Parameters:

res -

s -

c -

args -

Returns:

deleteTable

public void deleteTable(java.lang.String name)
                 throws java.lang.Exception

Throws:

java.lang.Exception

clearDatabase

public void clearDatabase()
                   throws java.lang.Exception

Throws:

java.lang.Exception

cleanup

public void cleanup()

Description copied from interface: AppContextCleanup

AppContext is being closed. Only use this for cleanup that can't be handled by normal garbage collection or for state which is never returned by reference.

Specified by:

cleanup in interface AppContextCleanup

getType

public java.lang.Class<? super DataBaseHandlerService> getType()

Description copied from interface: AppContextService

Returns the type of service the class should be registered under.

Specified by:

getType in interface AppContextService<DataBaseHandlerService>

Returns:

registration type