Package edu.suffolk.litlab.efspserver.tyler.codes

Class CodeDatabase

java.lang.Object

edu.suffolk.litlab.efspserver.db.Database

edu.suffolk.litlab.efspserver.ecfcodes.CodeDatabaseAPI

edu.suffolk.litlab.efspserver.tyler.codes.CodeDatabase

All Implemented Interfaces:

AutoCloseable

public class CodeDatabase
extends CodeDatabaseAPI

The class that interfaces with the database tables that contain the Tyler case codes.

Codes in this case doesn't mean programming code", it's more like code numbers code names for all of the different case details and information.

Author:

brycew

Field Summary

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

conn

Constructor Summary

Constructors

Constructor	Description
CodeDatabase(String jurisdiction, String env, Connection conn)

Method Summary

Modifier and Type	Method	Description
void	createIndicesIfAbsent(String tableName)
void	createTableIfAbsent(String tableName)
void	createTablesIfAbsent()
boolean	deleteFromTable(String tableName)
boolean	deleteFromTable(String tableName, String courtLocation)
static CodeDatabase	fromDS(String jurisdiction, String env, DataSource ds)
List<String>	getAllLocations()	Gets all court location identifiers (CLI) stored in the database. updateTable should have been called on the `location` table before this works.
List<FileType>	getAllowedFileTypes(String courtId)
List<CaseCategory>	getCaseCategoriesFor(String courtLocationId)
Optional<CaseCategory>	getCaseCategoryWithCode(String courtLocationId, String caseCatCode)
List<NameAndCode>	getCaseSubtypesFor(String courtLocationId, String caseType)
List<CaseType>	getCaseTypesFor(String courtLocationId, String caseCategoryCode, Optional<Boolean> initial)
Optional<CaseType>	getCaseTypeWith(String courtLocationId, String caseTypeCode)
List<CrossReference>	getCrossReference(String courtLocationId, String caseTypeId)
List<NameAndCode>	getDamageAmount(String courtLocationId, String caseCategory)
DataFieldRow	getDataField(String courtLocationId, String dataName)
List<NameAndCode>	getDataFieldNames(String courtLocationId)
DataFields	getDataFields(String courtLocationId)	gets all data fields if dataNames is empty, otherwise just those that match the code.
List<Disclaimer>	getDisclaimerRequirements(String courtLocation)
List<DocumentTypeTableRow>	getDocumentTypes(String courtLocationId, String filingCodeId)
String	getDomain()	The domain (the juristiction + environment, e.g. illinois-stage) that this database is working over.
List<CaseCategory>	getFilableCaseCategories(String courtLocationId, Optional<Boolean> initial)
List<NameAndCode>	getFileableLocationNames()
List<String>	getFileableLocations()
List<FilerType>	getFilerTypes(String courtId)
List<FilingComponent>	getFilingComponents(String courtLocationId, String filingCodeId)
List<NameAndCode>	getFilingStatuses(String courtId)
List<FilingCode>	getFilingType(String courtLocationId, String categoryCode, String typeCode, boolean initial)
Optional<FilingCode>	getFilingTypeWith(String courtLocationId, String filingCode)
Optional<CourtLocationInfo>	getFullLocationInfo(String courtId)
List<String>	getLanguageNames(String courtLocationId)
List<NameAndCode>	getLanguages(String courtLocationId)
List<NameAndCode>	getLocationNames()
List<NameAndCode>	getMotionTypes(String courtLocationId, String filingCodeId)
List<NameAndCode>	getNameSuffixes(String courtLocationId)
List<OptionalServiceCode>	getOptionalServices(String courtId, String filingCode)
List<OptionalServiceCode>	getOptionalServicesByCode(String courtId, String optServCode)
List<String>	getParentList(String courtId)	Gets the full line of succession for a given court, so given "cook:dv6", this would return ["cook:dv6", "cook:dv", "cook", "1", "0"]
List<PartyType>	getPartyTypeByCode(String courtLocationId, String partyTypeCode)
List<PartyType>	getPartyTypeFor(String courtLocationId, String caseTypeCode)	Gets the party types that are allowed for a given court and case type.
List<NameAndCode>	getProcedureOrRemedy(String courtLocationId, String caseCategory)
List<ServiceCodeType>	getServiceTypes(String courtLocationId)
List<String>	getStateCodes(String courtId, String country)
Map<String,List<String>>	getVersionsToUpdate()	Returns map of court locations to the list of tables they need to update.
static String	likeWildcard(String searchTerm)	In most cases, we want to find all instances of the search term, not the exact term.
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<CodeAndLocation>	retrieveFilingTypeByName(String caseTypeName)	Get the code and court locations of the filing types that match the given name exactly.
List<CodeAndLocation>	retrieveOptionalServices(String optServName)
List<CodeAndLocation>	retrievePartyType(String partyTypeName)
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.
List<String>	searchFilingType(String searchTerm)	Gets all distinct filing type names that have the search term in them.
List<String>	searchOptionalServices(String searchTerm)
List<String>	searchPartyType(String searchTerm)	Gets all distinct filing type names that have the search term in them.
PreparedStatement	singleInsert(PreparedStatement stmt, String tableName, String courtName, Map<String,String> rowsVals)
void	updateTable(String tableName, String courtName, InputStream inStream)
void	updateTable(String tableName, String courtName, CodeListDocument doc)
void	updateTableInner(String tableName, String courtName, CodeListDocument doc)
void	vacuumAll()

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

updateTable

Methods inherited from class edu.suffolk.litlab.efspserver.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

CodeDatabase

public CodeDatabase(String jurisdiction,
 String env,
 Connection conn)

Method Details

fromDS

public static CodeDatabase fromDS(String jurisdiction,
 String env,
 DataSource ds)

createTablesIfAbsent

public void createTablesIfAbsent()
                          throws SQLException

Specified by:

createTablesIfAbsent in class Database

Throws:

SQLException

getDomain

public String getDomain()

Description copied from class: CodeDatabaseAPI

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

Specified by:

getDomain in class CodeDatabaseAPI

createTableIfAbsent

public void createTableIfAbsent(String tableName)
                         throws SQLException

Specified by:

createTableIfAbsent in class CodeDatabaseAPI

Throws:

SQLException

createIndicesIfAbsent

public void createIndicesIfAbsent(String tableName)
                           throws SQLException

Throws:

SQLException

updateTable

public void updateTable(String tableName,
 String courtName,
 InputStream inStream)
                 throws jakarta.xml.bind.JAXBException,
SQLException,
XMLStreamException

Specified by:

updateTable in class CodeDatabaseAPI

Throws:

jakarta.xml.bind.JAXBException

SQLException

XMLStreamException

updateTable

public void updateTable(String tableName,
 String courtName,
 CodeListDocument doc)
                 throws SQLException

Specified by:

updateTable in class CodeDatabaseAPI

Throws:

SQLException

updateTableInner

public void updateTableInner(String tableName,
 String courtName,
 CodeListDocument doc)
                      throws SQLException

Throws:

SQLException

singleInsert

public PreparedStatement singleInsert(PreparedStatement stmt,
 String tableName,
 String courtName,
 Map<String,String> rowsVals)
                               throws SQLException

Throws:

SQLException

likeWildcard

public static String likeWildcard(String searchTerm)

In most cases, we want to find all instances of the search term, not the exact term. It's a LIKE compare, so add the 0 or more characters on either side.

Parameters:

searchTerm -

Returns:

searchCaseCategory

public List<String> searchCaseCategory(String searchTerm)

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

Parameters:

searchTerm -

Returns:

retrieveCaseCategoryByName

public List<CodeAndLocation> retrieveCaseCategoryByName(String categoryName)

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

Parameters:

categoryName -

Returns:

getCaseCategoriesFor

public List<CaseCategory> getCaseCategoriesFor(String courtLocationId)

getFilableCaseCategories

public List<CaseCategory> getFilableCaseCategories(String courtLocationId,
 Optional<Boolean> initial)

getCaseCategoryWithCode

public Optional<CaseCategory> getCaseCategoryWithCode(String courtLocationId,
 String caseCatCode)

searchCaseType

public List<String> searchCaseType(String searchTerm)

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

Parameters:

searchTerm -

Returns:

retrieveCaseTypeByName

public List<CodeAndLocation> retrieveCaseTypeByName(String caseTypeName)

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

Parameters:

caseTypeName -

Returns:

getCaseTypesFor

public List<CaseType> getCaseTypesFor(String courtLocationId,
 String caseCategoryCode,
 Optional<Boolean> initial)

getCaseTypeWith

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

getCaseSubtypesFor

public List<NameAndCode> getCaseSubtypesFor(String courtLocationId,
 String caseType)

getDataField

public DataFieldRow getDataField(String courtLocationId,
 String dataName)

getDataFieldNames

public List<NameAndCode> getDataFieldNames(String courtLocationId)

getDataFields

public DataFields getDataFields(String courtLocationId)

gets all data fields if dataNames is empty, otherwise just those that match the code.

getProcedureOrRemedy

public List<NameAndCode> getProcedureOrRemedy(String courtLocationId,
 String caseCategory)

searchFilingType

public List<String> searchFilingType(String searchTerm)

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

Parameters:

searchTerm -

Returns:

retrieveFilingTypeByName

public List<CodeAndLocation> retrieveFilingTypeByName(String caseTypeName)

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

Parameters:

caseTypeName -

Returns:

getFilingType

public List<FilingCode> getFilingType(String courtLocationId,
 String categoryCode,
 String typeCode,
 boolean initial)

getFilingTypeWith

public Optional<FilingCode> getFilingTypeWith(String courtLocationId,
 String filingCode)

vacuumAll

public void vacuumAll()

Specified by:

vacuumAll in class CodeDatabaseAPI

getDamageAmount

public List<NameAndCode> getDamageAmount(String courtLocationId,
 String caseCategory)

searchPartyType

public List<String> searchPartyType(String searchTerm)

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

Parameters:

searchTerm -

Returns:

retrievePartyType

public List<CodeAndLocation> retrievePartyType(String partyTypeName)

getPartyTypeFor

public List<PartyType> getPartyTypeFor(String courtLocationId,
 String caseTypeCode)

Gets the party types that are allowed for a given court and case type.

Parameters:

courtLocationId -

caseTypeCode - Nullable, if null, gets all party types for court, otherwise, just for that case type.

Returns:

a list of party types

getPartyTypeByCode

public List<PartyType> getPartyTypeByCode(String courtLocationId,
 String partyTypeCode)

getCrossReference

public List<CrossReference> getCrossReference(String courtLocationId,
 String caseTypeId)

getServiceTypes

public List<ServiceCodeType> getServiceTypes(String courtLocationId)

getDocumentTypes

public List<DocumentTypeTableRow> getDocumentTypes(String courtLocationId,
 String filingCodeId)

getMotionTypes

public List<NameAndCode> getMotionTypes(String courtLocationId,
 String filingCodeId)

getNameSuffixes

public List<NameAndCode> getNameSuffixes(String courtLocationId)

getFilingComponents

public List<FilingComponent> getFilingComponents(String courtLocationId,
 String filingCodeId)

getStateCodes

public List<String> getStateCodes(String courtId,
 String country)

getAllowedFileTypes

public List<FileType> getAllowedFileTypes(String courtId)

getFilerTypes

public List<FilerType> getFilerTypes(String courtId)

getFilingStatuses

public List<NameAndCode> getFilingStatuses(String courtId)

searchOptionalServices

public List<String> searchOptionalServices(String searchTerm)

retrieveOptionalServices

public List<CodeAndLocation> retrieveOptionalServices(String optServName)

getOptionalServicesByCode

public List<OptionalServiceCode> getOptionalServicesByCode(String courtId,
 String optServCode)

getOptionalServices

public List<OptionalServiceCode> getOptionalServices(String courtId,
 String filingCode)

getLanguageNames

public List<String> getLanguageNames(String courtLocationId)

getLanguages

public List<NameAndCode> getLanguages(String courtLocationId)

getVersionsToUpdate

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

Returns map of court locations to the list of tables they need to update.

Specified by:

getVersionsToUpdate 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

Specified by:

deleteFromTable in class CodeDatabaseAPI

Throws:

SQLException

getAllLocations

public List<String> getAllLocations()

Gets all court location identifiers (CLI) stored in the database. updateTable should have been called on the `location` table before this works.

Specified by:

getAllLocations in class CodeDatabaseAPI

Returns:

a list of all valid CLIs for this jurisdiction

getLocationNames

public List<NameAndCode> getLocationNames()

getFileableLocations

public List<String> getFileableLocations()

getFileableLocationNames

public List<NameAndCode> getFileableLocationNames()

getFullLocationInfo

public Optional<CourtLocationInfo> getFullLocationInfo(String courtId)

getParentList

public List<String> getParentList(String courtId)

Gets the full line of succession for a given court, so given "cook:dv6", this would return ["cook:dv6", "cook:dv", "cook", "1", "0"]

getDisclaimerRequirements

public List<Disclaimer> getDisclaimerRequirements(String courtLocation)