Package edu.suffolk.litlab.efsp.truefiling.ecfcodes

Class TFCodeDatabase

java.lang.Object

edu.suffolk.litlab.efsp.db.Database

edu.suffolk.litlab.efsp.ecfcodes.CodeDatabaseAPI

edu.suffolk.litlab.efsp.truefiling.ecfcodes.TFCodeDatabase

All Implemented Interfaces:

AutoCloseable

public class TFCodeDatabase
extends CodeDatabaseAPI

Field Summary

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

conn

Constructor Summary

Constructors

Constructor	Description
TFCodeDatabase(Jurisdiction jurisdiction, TrueFilingEnv env, Connection conn)

Method Summary

Modifier and Type	Method	Description
List<String>	courtCoverageCaseCategory(String searchTerm)
List<String>	courtCoverageCaseType(String searchTerm)
void	createTableIfAbsent(String tableName)
void	createTablesIfAbsent()
boolean	deleteFromTable(String tableName)
boolean	deleteFromTable(String tableName, String courtLocation)	Deletes all entries in a domain from a table in the given table from courtLocation .
static TFCodeDatabase	fromDS(Jurisdiction jurisdiction, TrueFilingEnv env, DataSource ds)
List<String>	getAllLocations()	Gets all court location identifiers (CLI) stored in the database.
List<NameAndCode>	getBundleStatuses(String location)
List<CaseCategory>	getCaseCategories(String courtLocationId)
List<NameAndCode>	getCaseCategoryNames(String courtLocationId)
List<NameAndCode>	getCaseTypeNamesFor(String courtLocationId, String caseCategoryCode, Optional<Boolean> initial)
Optional<CaseType>	getCaseTypeWith(String courtLocationId, UUID caseTypeCode)
List<NameAndCode>	getCauseOfActionCodes()
List<NameAndCode>	getDocumentStatuses(String location)
List<NameAndCode>	getDocumentTypes(String location, String caseTypeCode)
List<NameAndCode>	getErrorCodes(String location)
List<NameAndCode>	getFeeExceptionReasons(String location)
List<NameAndCode>	getFileableInitialLocationNames()
List<NameAndCode>	getFileableLocationNames()
List<NameAndCode>	getFileableSubsequentLocationNames()
Jurisdiction	getJurisdiction()	The jurisdiction (e.g illinois) that this database is working over
List<NameAndCode>	getLocationNames()
List<NameAndCode>	getPartyTypeFor(String court)
Map<String,List<String>>	getVersionsToUpdate()	Returns a map from court names to tables that needed to be updated for it.
List<CodeAndLocation>	retrieveCaseCategoryByName(String categoryName)	Get the code and court locations of the case categories that match the given name exactly.
List<CodeAndLocation>	retrieveCaseTypeByName(String caseTypeName)	Get the code and court locations of the case types that match the given name exactly.
List<String>	searchCaseCategory(String searchTerm)	Gets all distinct case category names that have the search term in them.
List<String>	searchCaseType(String searchTerm)	Gets all distinct case type names that have the search term in them.
Set<String>	systemTables()
void	updateTable(String tableName, String courtName, InputStream is)
void	updateTable(String tableName, String courtName, String newVersion, Iterator<Map<String,String>> rows)	The iterator (rows) will be consumed by this function.
void	vacuumAll()
Map<String,String>	xmlElemToTableName()	Maps the name of an ECF element to be substituted by a court-specific code list or extension.

Methods inherited from class edu.suffolk.litlab.efsp.ecfcodes.CodeDatabaseAPI

genericSearch, indiciesExists, safetyWrap, safetyWrapOpt, tableExists, validTable

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

close, commit, rollback, setAutoCommit, setSavepoint

Methods inherited from class java.lang.Object

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

Constructor Details

TFCodeDatabase

public TFCodeDatabase(Jurisdiction jurisdiction,
 TrueFilingEnv env,
 Connection conn)

Method Details

fromDS

public static TFCodeDatabase fromDS(Jurisdiction jurisdiction,
 TrueFilingEnv env,
 DataSource ds)

getJurisdiction

public Jurisdiction getJurisdiction()

Description copied from class: CodeDatabaseAPI

The jurisdiction (e.g illinois) that this database is working over

Specified by:

getJurisdiction in class CodeDatabaseAPI

xmlElemToTableName

public Map<String,String> xmlElemToTableName()

Description copied from class: CodeDatabaseAPI

Maps the name of an ECF element to be substituted by a court-specific code list or extension.

Specified by:

xmlElemToTableName in class CodeDatabaseAPI

systemTables

public Set<String> systemTables()

Specified by:

systemTables in class CodeDatabaseAPI

getAllLocations

public List<String> getAllLocations()

Description copied from class: CodeDatabaseAPI

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

Specified by:

getAllLocations in class CodeDatabaseAPI

Returns:

a list of all valid CLIs for this jurisdiction

getLocationNames

public List<NameAndCode> getLocationNames()

Specified by:

getLocationNames in class CodeDatabaseAPI

getFileableLocationNames

public List<NameAndCode> getFileableLocationNames()

Specified by:

getFileableLocationNames in class CodeDatabaseAPI

getFileableInitialLocationNames

public List<NameAndCode> getFileableInitialLocationNames()

Specified by:

getFileableInitialLocationNames in class CodeDatabaseAPI

getFileableSubsequentLocationNames

public List<NameAndCode> getFileableSubsequentLocationNames()

Specified by:

getFileableSubsequentLocationNames in class CodeDatabaseAPI

getPartyTypeFor

public List<NameAndCode> getPartyTypeFor(String court)

updateTable

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

Specified by:

updateTable in class CodeDatabaseAPI

Throws:

SQLException

CodeDocException

updateTable

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

Description copied from class: CodeDatabaseAPI

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

Specified by:

updateTable in class CodeDatabaseAPI

Throws:

SQLException

deleteFromTable

public boolean deleteFromTable(String tableName)
                        throws SQLException

Specified by:

deleteFromTable in class CodeDatabaseAPI

Throws:

SQLException

deleteFromTable

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

Description copied from class: CodeDatabaseAPI

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

Specified by:

deleteFromTable in class CodeDatabaseAPI

Throws:

SQLException

createTableIfAbsent

public void createTableIfAbsent(String tableName)
                         throws SQLException

Specified by:

createTableIfAbsent in class CodeDatabaseAPI

Throws:

SQLException

getVersionsToUpdate

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

Description copied from class: CodeDatabaseAPI

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

Specified by:

getVersionsToUpdate in class CodeDatabaseAPI

Throws:

SQLException

vacuumAll

public void vacuumAll()

Specified by:

vacuumAll in class CodeDatabaseAPI

searchCaseCategory

public List<String> searchCaseCategory(String searchTerm)

Description copied from class: CodeDatabaseAPI

Gets all distinct case category names that have the search term in them.

Specified by:

searchCaseCategory in class CodeDatabaseAPI

Parameters:

searchTerm -

Returns:

courtCoverageCaseCategory

public List<String> courtCoverageCaseCategory(String searchTerm)

Specified by:

courtCoverageCaseCategory in class CodeDatabaseAPI

retrieveCaseCategoryByName

public List<CodeAndLocation> retrieveCaseCategoryByName(String categoryName)

Description copied from class: CodeDatabaseAPI

Get the code and court locations of the case categories that match the given name exactly.

Specified by:

retrieveCaseCategoryByName in class CodeDatabaseAPI

Parameters:

categoryName -

Returns:

getCaseCategoryNames

public List<NameAndCode> getCaseCategoryNames(String courtLocationId)

Specified by:

getCaseCategoryNames in class CodeDatabaseAPI

getCaseCategories

public List<CaseCategory> getCaseCategories(String courtLocationId)

searchCaseType

public List<String> searchCaseType(String searchTerm)

Description copied from class: CodeDatabaseAPI

Gets all distinct case type names that have the search term in them.

Specified by:

searchCaseType in class CodeDatabaseAPI

Parameters:

searchTerm -

Returns:

courtCoverageCaseType

public List<String> courtCoverageCaseType(String searchTerm)

Specified by:

courtCoverageCaseType in class CodeDatabaseAPI

retrieveCaseTypeByName

public List<CodeAndLocation> retrieveCaseTypeByName(String caseTypeName)

Description copied from class: CodeDatabaseAPI

Get the code and court locations of the case types that match the given name exactly.

Specified by:

retrieveCaseTypeByName in class CodeDatabaseAPI

Parameters:

caseTypeName -

Returns:

getCaseTypeNamesFor

public List<NameAndCode> getCaseTypeNamesFor(String courtLocationId,
 String caseCategoryCode,
 Optional<Boolean> initial)

Specified by:

getCaseTypeNamesFor in class CodeDatabaseAPI

getCaseTypeWith

public Optional<CaseType> getCaseTypeWith(String courtLocationId,
 UUID caseTypeCode)

getCauseOfActionCodes

public List<NameAndCode> getCauseOfActionCodes()

getBundleStatuses

public List<NameAndCode> getBundleStatuses(String location)

getDocumentStatuses

public List<NameAndCode> getDocumentStatuses(String location)

getDocumentTypes

public List<NameAndCode> getDocumentTypes(String location,
 String caseTypeCode)

getErrorCodes

public List<NameAndCode> getErrorCodes(String location)

getFeeExceptionReasons

public List<NameAndCode> getFeeExceptionReasons(String location)

createTablesIfAbsent

public void createTablesIfAbsent()
                          throws SQLException

Specified by:

createTablesIfAbsent in class Database

Throws:

SQLException