Package edu.suffolk.litlab.efsp.ecfcodes

Class CodeDatabaseAPI

java.lang.Object

edu.suffolk.litlab.efsp.db.Database

edu.suffolk.litlab.efsp.ecfcodes.CodeDatabaseAPI

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

CodeDatabase

public abstract class CodeDatabaseAPI
extends Database

ECF says that certain parts of the information model of the data that we exchange with the EFM is contained in Genericode code lists. The EfileProxyServer saves those Genericode code lists in a SQL database, for immediate use.

This class is the exposed interface between the SQL databases that store genericode info and the rest of the proxy server, particularly { CodeUpdater }. It should be instanianted once per jurisiction.

Field Summary

Fields inherited from class edu.suffolk.litlab.efsp.db.Database

conn

Constructor Summary

Constructors

Constructor	Description
CodeDatabaseAPI(Connection conn)

Method Summary

Modifier and Type	Method	Description
abstract void	createTableIfAbsent(String tableName)
abstract boolean	deleteFromTable(String tableName)
abstract boolean	deleteFromTable(String tableName, String courtLocation)	Deletes all entries in a domain from a table in the given table from courtLocation .
abstract List<String>	getAllLocations()	Gets all court location identifiers (CLI) stored in the database.
abstract TylerDomain	getDomain()	The domain (the juristiction + environment, e.g. illinois-stage) that this database is working over.
abstract Map<String,List<String>>	getVersionsToUpdate()	Returns a map from court names to tables that needed to be updated for it.
abstract void	updateTable(String tableName, String courtName, InputStream is)
abstract void	updateTable(String tableName, String courtName, String newVersion, Iterator<Map<String,String>> rows)	The iterator (rows) will be consumed by this function.
abstract void	vacuumAll()

Methods inherited from class edu.suffolk.litlab.efsp.db.Database

close, commit, createTablesIfAbsent, rollback, setAutoCommit, setSavepoint

Methods inherited from class java.lang.Object

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

Constructor Details

CodeDatabaseAPI

public CodeDatabaseAPI(Connection conn)

Method Details

getDomain

public abstract TylerDomain getDomain()

The domain (the juristiction + environment, e.g. illinois-stage) that this database is working over.

getAllLocations

public abstract List<String> getAllLocations()

Gets all court location identifiers (CLI) stored in the database.

Returns:

a list of all valid CLIs for this jurisdiction

updateTable

public abstract void updateTable(String tableName,
 String courtName,
 InputStream is)
                          throws SQLException,
CodeDocException

Throws:

SQLException

CodeDocException

updateTable

public abstract void updateTable(String tableName,
 String courtName,
 String newVersion,
 Iterator<Map<String,String>> rows)
                          throws SQLException

The iterator (rows) will be consumed by this function.

Throws:

SQLException

deleteFromTable

public abstract boolean deleteFromTable(String tableName)
                                 throws SQLException

Throws:

SQLException

deleteFromTable

public abstract boolean deleteFromTable(String tableName,
 String courtLocation)
                                 throws SQLException

Deletes all entries in a domain from a table in the given table from courtLocation .

Throws:

SQLException

createTableIfAbsent

public abstract void createTableIfAbsent(String tableName)
                                  throws SQLException

Throws:

SQLException

getVersionsToUpdate

public abstract Map<String,List<String>> getVersionsToUpdate()
                                                      throws SQLException

Returns a map from court names to tables that needed to be updated for it.

Throws:

SQLException

vacuumAll

public abstract void vacuumAll()