Package edu.suffolk.litlab.efsp.tyler.ecfcodes

Class TylerCodesParser

java.lang.Object

edu.suffolk.litlab.efsp.tyler.ecfcodes.TylerCodesParser

All Implemented Interfaces:

CodesParser, AutoCloseable

public class TylerCodesParser
extends Object
implements CodesParser

All of the Tyler code specific conversions and logic checks from our objects (really light wrappers over the JSON objects).

The `vetXYZ` functions here check that the given inputs work with Tyler's expectations. They return Results; ok for this is good, and an error (with the specific typed-reason) when it will be rejected.

Nested Class Summary

Nested classes/interfaces inherited from interface edu.suffolk.litlab.efsp.ecfcodes.CodesParser

CodesParser.AttorneyError, CodesParser.BadCode, CodesParser.CodeError, CodesParser.CrossReferenceError, CodesParser.CumulativeDocsTooBig, CodesParser.DocTooBig, CodesParser.DueDateRequired, CodesParser.FileExtensionNotAllowed, CodesParser.FileNameError, CodesParser.FileNameTextError, CodesParser.FilingDocError, CodesParser.InputOptionalService, CodesParser.InvalidFilingAction, CodesParser.MissingRequiredRefs, CodesParser.MissingVar, CodesParser.NoMatchingCode, CodesParser.NoMatchingRef, CodesParser.NoMultipleAttorneys, CodesParser.RequiredAttorneys, CodesParser.RequiredCodeNotPresent, CodesParser.TextVarError, CodesParser.ThingRequired, CodesParser.TooLongVar, CodesParser.WrongRefVal, CodesParser.WrongVar

Constructor Summary

Constructors

Constructor	Description
TylerCodesParser(CodeDatabase cd, DevelopmentPolicyParametersType policy, CourtLocationInfo court, boolean isIndividual)
TylerCodesParser(CodeDatabase cd, DevelopmentPolicyParametersType policy, CourtLocationInfo court, DataFields allDataFields, boolean isIndividual)

Method Summary

Modifier and Type	Method	Description
void	close()
com.hubspot.algebra.Result<Map<String,String>,CodesParser.CrossReferenceError>	getCrossRefIds(Map<String,String> crossRefs, CaseType caseType)
Optional<String>	getDocumentDescription(String description, String firstFileName, FilingCode filing)
static Optional<CodesParser>	makeParser(CodeDatabase cd, DevelopmentPolicyParametersType policy, String courtId, boolean isIndividual)
List<FilingComponent>	retrieveFilingComponents(FilingCode filingCode)
com.hubspot.algebra.Result<List<FilingCode>,CodesParser.BadCode>	retrieveFilingOptions(CaseCategory caseCategory, CaseType type, boolean isInitialFiling)
boolean	useFilingAssociations()	Get if we need to add an association between filings and case parties.
com.hubspot.algebra.Result<Optional<BigDecimal>,CodesParser.ThingRequired>	vetAmountInControversy(Optional<BigDecimal> amt, List<FilingCode> filings)
com.hubspot.algebra.Result<CaseCategory,CodesParser.CodeError>	vetCaseCat(String caseCategoryCode)
com.hubspot.algebra.Result<CaseType,CodesParser.CodeError>	vetCaseType(String caseTypeCode, CaseCategory caseCategory, boolean isInitialFiling)
com.hubspot.algebra.Result<Optional<String>,CodesParser.TextVarError>	vetComment(Optional<String> maybeComment)
com.hubspot.algebra.Result<Optional<NameAndCode>,CodesParser.CodeError>	vetDamageAmount(boolean initial, CaseCategory cat, Optional<String> maybeDamageAmount)
com.hubspot.algebra.Result<Optional<DocumentTypeTableRow>,CodesParser.CodeError>	vetDocType(String docTypeStr, FilingCode filing)
com.hubspot.algebra.Result<Optional<LocalDate>,CodesParser.DueDateRequired>	vetDueDate(Optional<LocalDate> dueDate, FilingCode filing)
com.hubspot.algebra.Result<Optional<String>,CodesParser.TextVarError>	vetEmail(Optional<String> email)	Throws if something is wrong; otherwise, an optional email (empty does not mean error!).
com.hubspot.algebra.Result<String,CodesParser.FileNameError>	vetFileName(String fileName)
com.hubspot.algebra.Result<Optional<FilerType>,CodesParser.CodeError>	vetFilerType(Optional<String> maybeFilerType)
com.hubspot.algebra.Result<Optional<FilingAction>,CodesParser.InvalidFilingAction>	vetFilingAction(Optional<FilingAction> filingAction, boolean isInitialFiling, boolean hasServiceContacts)
com.hubspot.algebra.Result<Optional<String>,CodesParser.TextVarError>	vetFilingAttorney(Optional<String> filingAttorney)
com.hubspot.algebra.Result<FilingComponent,CodesParser.CodeError>	vetFilingComponent(String filingComponent, ArrayList<FilingComponent> components)	NOTE: modifies the components list, removing the selected component if allowmultiple is false.
com.hubspot.algebra.Result<com.hubspot.algebra.NullValue,CodesParser.FilingDocError>	vetFilingDocSize(List<FilingDoc> docs)
com.hubspot.algebra.Result<List<PartyId>,CodesParser.ThingRequired>	vetFilingParties(List<PartyId> filingParties)
com.hubspot.algebra.Result<Optional<String>,CodesParser.TextVarError>	vetFilingRefNum(Optional<String> fileRefNum)
com.hubspot.algebra.Result<FilingCode,CodesParser.CodeError>	vetFilingType(Optional<String> filingStr, List<FilingCode> filingOptions)
com.hubspot.algebra.Result<String,CodesParser.TextVarError>	vetFirstName(Optional<String> name)
com.hubspot.algebra.Result<Optional<Person.Gender>,CodesParser.TextVarError>	vetGender(Optional<String> gender)
com.hubspot.algebra.Result<Optional<String>,CodesParser.CodeError>	vetLangCode(Optional<String> lang)
com.hubspot.algebra.Result<String,CodesParser.TextVarError>	vetLastName(Optional<String> name)
Optional<BigDecimal>	vetMaxAmount(Optional<BigDecimal> maxAmount)
com.hubspot.algebra.Result<String,CodesParser.TextVarError>	vetMiddleName(Optional<String> name)
com.hubspot.algebra.Result<Optional<NameAndCode>,CodesParser.CodeError>	vetMotionCode(Optional<String> motionCode, FilingCode filing)
com.hubspot.algebra.Result<List<OptionalService>,List<CodesParser.CodeError>>	vetOptionalServices(List<CodesParser.InputOptionalService> servs, FilingCode filing)	Checks all of the optional services in one go.
com.hubspot.algebra.Result<String,CodesParser.TextVarError>	vetOrgName(String name)	Doesn't return optional because we can set the People names to null / blank.
com.hubspot.algebra.Result<Optional<Map<PartyId,List<String>>>,CodesParser.AttorneyError>	vetPartyAttorneyMap(Map<PartyId,List<String>> partyAttyMap, Collection<PartyId> partyIdSet, Collection<String> attySet)
com.hubspot.algebra.Result<Map<PartyId,PartyInfo>,CodesParser.CodeError>	vetPartyTypes(Collection<Person> existingParties, Collection<Person> newParties, CaseType type, boolean isFirstIndexedFiling)	existingPartyCodes: str of Tyler party ID to their role code string newPartyCodes: str of our generated ID of party to their role code string
com.hubspot.algebra.Result<List<String>,CodesParser.TextVarError>	vetPhoneNumbers(List<String> numbers)
com.hubspot.algebra.Result<Optional<NameAndCode>,CodesParser.CodeError>	vetProcedureRemedy(Optional<String> maybeProRem, boolean initial, CaseCategory cat)
com.hubspot.algebra.Result<String,CodesParser.CodeError>	vetStateCode(String state, String countryString)
com.hubspot.algebra.Result<Optional<NameAndCode>,CodesParser.NoMatchingCode>	vetSubType(String subtypeCode, CaseType caseType)
com.hubspot.algebra.Result<String,CodesParser.CodeError>	vetSuffix(Optional<String> maybeSuffix)

Methods inherited from class java.lang.Object

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

Constructor Details

TylerCodesParser

public TylerCodesParser(CodeDatabase cd,
 DevelopmentPolicyParametersType policy,
 CourtLocationInfo court,
 DataFields allDataFields,
 boolean isIndividual)

TylerCodesParser

public TylerCodesParser(CodeDatabase cd,
 DevelopmentPolicyParametersType policy,
 CourtLocationInfo court,
 boolean isIndividual)

Method Details

makeParser

public static Optional<CodesParser> makeParser(CodeDatabase cd,
 DevelopmentPolicyParametersType policy,
 String courtId,
 boolean isIndividual)

close

public void close()
           throws SQLException

Specified by:

close in interface AutoCloseable

Throws:

SQLException

vetCaseCat

public com.hubspot.algebra.Result<CaseCategory,CodesParser.CodeError> vetCaseCat(String caseCategoryCode)

Specified by:

vetCaseCat in interface CodesParser

vetCaseType

public com.hubspot.algebra.Result<CaseType,CodesParser.CodeError> vetCaseType(String caseTypeCode,
 CaseCategory caseCategory,
 boolean isInitialFiling)

Specified by:

vetCaseType in interface CodesParser

vetSubType

public com.hubspot.algebra.Result<Optional<NameAndCode>,CodesParser.NoMatchingCode> vetSubType(String subtypeCode,
 CaseType caseType)

Specified by:

vetSubType in interface CodesParser

retrieveFilingOptions

public com.hubspot.algebra.Result<List<FilingCode>,CodesParser.BadCode> retrieveFilingOptions(CaseCategory caseCategory,
 CaseType type,
 boolean isInitialFiling)

Specified by:

retrieveFilingOptions in interface CodesParser

vetFilingType

public com.hubspot.algebra.Result<FilingCode,CodesParser.CodeError> vetFilingType(Optional<String> filingStr,
 List<FilingCode> filingOptions)

Specified by:

vetFilingType in interface CodesParser

vetSuffix

public com.hubspot.algebra.Result<String,CodesParser.CodeError> vetSuffix(Optional<String> maybeSuffix)

Specified by:

vetSuffix in interface CodesParser

vetLangCode

public com.hubspot.algebra.Result<Optional<String>,CodesParser.CodeError> vetLangCode(Optional<String> lang)

Specified by:

vetLangCode in interface CodesParser

vetStateCode

public com.hubspot.algebra.Result<String,CodesParser.CodeError> vetStateCode(String state,
 String countryString)

Specified by:

vetStateCode in interface CodesParser

getCrossRefIds

public com.hubspot.algebra.Result<Map<String,String>,CodesParser.CrossReferenceError> getCrossRefIds(Map<String,String> crossRefs,
 CaseType caseType)

Specified by:

getCrossRefIds in interface CodesParser

vetPartyTypes

public com.hubspot.algebra.Result<Map<PartyId,PartyInfo>,CodesParser.CodeError> vetPartyTypes(Collection<Person> existingParties,
 Collection<Person> newParties,
 CaseType type,
 boolean isFirstIndexedFiling)

existingPartyCodes: str of Tyler party ID to their role code string newPartyCodes: str of our generated ID of party to their role code string

Specified by:

vetPartyTypes in interface CodesParser

Returns:

the combined map of tyler ids and our ids to each party type

vetFilingParties

public com.hubspot.algebra.Result<List<PartyId>,CodesParser.ThingRequired> vetFilingParties(List<PartyId> filingParties)

Specified by:

vetFilingParties in interface CodesParser

vetMotionCode

public com.hubspot.algebra.Result<Optional<NameAndCode>,CodesParser.CodeError> vetMotionCode(Optional<String> motionCode,
 FilingCode filing)

Specified by:

vetMotionCode in interface CodesParser

vetOptionalServices

public com.hubspot.algebra.Result<List<OptionalService>,List<CodesParser.CodeError>> vetOptionalServices(List<CodesParser.InputOptionalService> servs,
 FilingCode filing)

Checks all of the optional services in one go. Can't return OptionalServiceCode, since it doesn't have the selected multiplier / fee amount.

Specified by:

vetOptionalServices in interface CodesParser

retrieveFilingComponents

public List<FilingComponent> retrieveFilingComponents(FilingCode filingCode)

Specified by:

retrieveFilingComponents in interface CodesParser

vetFilingComponent

public com.hubspot.algebra.Result<FilingComponent,CodesParser.CodeError> vetFilingComponent(String filingComponent,
 ArrayList<FilingComponent> components)

NOTE: modifies the components list, removing the selected component if allowmultiple is false.

Specified by:

vetFilingComponent in interface CodesParser

Parameters:

filingComponent -

components -

collector -

Returns:

vetDocType

public com.hubspot.algebra.Result<Optional<DocumentTypeTableRow>,CodesParser.CodeError> vetDocType(String docTypeStr,
 FilingCode filing)

Specified by:

vetDocType in interface CodesParser

vetFilerType

public com.hubspot.algebra.Result<Optional<FilerType>,CodesParser.CodeError> vetFilerType(Optional<String> maybeFilerType)

Specified by:

vetFilerType in interface CodesParser

vetProcedureRemedy

public com.hubspot.algebra.Result<Optional<NameAndCode>,CodesParser.CodeError> vetProcedureRemedy(Optional<String> maybeProRem,
 boolean initial,
 CaseCategory cat)

Specified by:

vetProcedureRemedy in interface CodesParser

vetDamageAmount

public com.hubspot.algebra.Result<Optional<NameAndCode>,CodesParser.CodeError> vetDamageAmount(boolean initial,
 CaseCategory cat,
 Optional<String> maybeDamageAmount)

Specified by:

vetDamageAmount in interface CodesParser

vetPartyAttorneyMap

public com.hubspot.algebra.Result<Optional<Map<PartyId,List<String>>>,CodesParser.AttorneyError> vetPartyAttorneyMap(Map<PartyId,List<String>> partyAttyMap,
 Collection<PartyId> partyIdSet,
 Collection<String> attySet)

Specified by:

vetPartyAttorneyMap in interface CodesParser

vetFilingAttorney

public com.hubspot.algebra.Result<Optional<String>,CodesParser.TextVarError> vetFilingAttorney(Optional<String> filingAttorney)

Specified by:

vetFilingAttorney in interface CodesParser

vetEmail

public com.hubspot.algebra.Result<Optional<String>,CodesParser.TextVarError> vetEmail(Optional<String> email)

Throws if something is wrong; otherwise, an optional email (empty does not mean error!).

Note that the collector type is what determines if it throws.

Specified by:

vetEmail in interface CodesParser

Parameters:

email -

collector -

Returns:

vetPhoneNumbers

public com.hubspot.algebra.Result<List<String>,CodesParser.TextVarError> vetPhoneNumbers(List<String> numbers)

Specified by:

vetPhoneNumbers in interface CodesParser

vetFirstName

public com.hubspot.algebra.Result<String,CodesParser.TextVarError> vetFirstName(Optional<String> name)

Specified by:

vetFirstName in interface CodesParser

vetMiddleName

public com.hubspot.algebra.Result<String,CodesParser.TextVarError> vetMiddleName(Optional<String> name)

Specified by:

vetMiddleName in interface CodesParser

vetLastName

public com.hubspot.algebra.Result<String,CodesParser.TextVarError> vetLastName(Optional<String> name)

Specified by:

vetLastName in interface CodesParser

vetOrgName

public com.hubspot.algebra.Result<String,CodesParser.TextVarError> vetOrgName(String name)

Doesn't return optional because we can set the People names to null / blank.

Specified by:

vetOrgName in interface CodesParser

Parameters:

name -

row -

collector -

var -

Returns:

vetGender

public com.hubspot.algebra.Result<Optional<Person.Gender>,CodesParser.TextVarError> vetGender(Optional<String> gender)

Specified by:

vetGender in interface CodesParser

vetFilingRefNum

public com.hubspot.algebra.Result<Optional<String>,CodesParser.TextVarError> vetFilingRefNum(Optional<String> fileRefNum)

Specified by:

vetFilingRefNum in interface CodesParser

vetComment

public com.hubspot.algebra.Result<Optional<String>,CodesParser.TextVarError> vetComment(Optional<String> maybeComment)

Specified by:

vetComment in interface CodesParser

vetDueDate

public com.hubspot.algebra.Result<Optional<LocalDate>,CodesParser.DueDateRequired> vetDueDate(Optional<LocalDate> dueDate,
 FilingCode filing)

Specified by:

vetDueDate in interface CodesParser

vetFilingAction

public com.hubspot.algebra.Result<Optional<FilingAction>,CodesParser.InvalidFilingAction> vetFilingAction(Optional<FilingAction> filingAction,
 boolean isInitialFiling,
 boolean hasServiceContacts)

Specified by:

vetFilingAction in interface CodesParser

getDocumentDescription

public Optional<String> getDocumentDescription(String description,
 String firstFileName,
 FilingCode filing)

Specified by:

getDocumentDescription in interface CodesParser

vetFileName

public com.hubspot.algebra.Result<String,CodesParser.FileNameError> vetFileName(String fileName)

Specified by:

vetFileName in interface CodesParser

vetFilingDocSize

public com.hubspot.algebra.Result<com.hubspot.algebra.NullValue,CodesParser.FilingDocError> vetFilingDocSize(List<FilingDoc> docs)

Specified by:

vetFilingDocSize in interface CodesParser

vetAmountInControversy

public com.hubspot.algebra.Result<Optional<BigDecimal>,CodesParser.ThingRequired> vetAmountInControversy(Optional<BigDecimal> amt,
 List<FilingCode> filings)

Specified by:

vetAmountInControversy in interface CodesParser

vetMaxAmount

public Optional<BigDecimal> vetMaxAmount(Optional<BigDecimal> maxAmount)

Specified by:

vetMaxAmount in interface CodesParser

useFilingAssociations

public boolean useFilingAssociations()

Get if we need to add an association between filings and case parties. Is simply a boolean because there's no filing error that needs to be swallowed.

Specified by:

useFilingAssociations in interface CodesParser

Returns: