Starting the new standard for case search stuff

Implements #135

Author: BryceStevenWilley

.gitignore

@@ -90,4 +90,4 @@ google-java-format_*
 # MKDocs Output
 site
 
-.jqwik-database
+.jqwik-database

proxyserver/src/main/java/edu/suffolk/litlab/efsp/model/Name.java

@@ -21,11 +21,29 @@ public Name(
       String lastName,
       String suffix,
       String maidenName) {
+    if (prefix == null) {
+      prefix = "";
+    }
     this.prefix = prefix;
+    if (firstName == null) {
+      firstName = "";
+    }
     this.firstName = firstName;
+    if (middleName == null) {
+      middleName = "";
+    }
     this.middleName = middleName;
+    if (lastName == null) {
+      lastName = "";
+    }
     this.lastName = lastName;
+    if (suffix == null) {
+      suffix = "";
+    }
     this.suffix = suffix;
+    if (maidenName == null) {
+      maidenName = "";
+    }
     this.maidenName = maidenName;
   }
 
@@ -39,6 +57,9 @@ public Name(String firstName, String middleName, String lastName) {
 
   /** The full name, with no extra spaces. */
   public String getFullName() {
+    if (prefix.isBlank() && firstName.isBlank() && middleName.isBlank() && suffix.isBlank()) {
+      return "(No name given)";
+    }
     return Stream.of(prefix, firstName, middleName, lastName, suffix)
         .reduce(
             (wd, n) -> {
@@ -65,9 +86,15 @@ public String getLastName() {
     return lastName;
   }
 
-  /** If there's only a first name, then us it, otherwise take only the last name */
+  /**
+   * If there's only a first name, then us it, otherwise take only the last name. Used to create the
+   * titles of cases, i.e. Jones v. Discover, etc.
+   */
   public String getTitleName() {
     if (lastName == null || lastName.isBlank()) {
+      if (firstName == null || firstName.isBlank()) {
+        return "(Unnamed)";
+      }
       return firstName;
     } else {
       return lastName;

proxyserver/src/main/java/edu/suffolk/litlab/efsp/model/cases/Attorney.java

@@ -0,0 +1,13 @@
+package edu.suffolk.litlab.efsp.model.cases;
+
+import edu.suffolk.litlab.efsp.model.ContactInformation;
+import edu.suffolk.litlab.efsp.model.Name;
+
+public class Attorney extends Person {
+  String attorneyId;
+  String barNumber;
+
+  public Attorney(Name name, ContactInformation contactInformation) {
+    super(name, contactInformation);
+  }
+}

proxyserver/src/main/java/edu/suffolk/litlab/efsp/model/cases/CaseResponse.java

@@ -0,0 +1,20 @@
+package edu.suffolk.litlab.efsp.model.cases;
+
+import edu.suffolk.litlab.efsp.ecfcodes.tyler.CaseCategory;
+import edu.suffolk.litlab.efsp.ecfcodes.tyler.CaseType;
+import edu.suffolk.litlab.efsp.model.Person;
+import java.time.LocalDateTime;
+import java.util.List;
+import java.util.Map;
+
+/** All of the information Tyler sends about a particular case. */
+public class CaseResponse {
+  List<Person> participants;
+  Map<String, Attorney> attorneys;
+
+  CaseCategory caseCategory;
+  CaseType caseType;
+  String caseTitle;
+  LocalDateTime filedDate;
+  // TODO(Attorneys)
+}

proxyserver/src/main/java/edu/suffolk/litlab/efsp/model/cases/ECFToReturn.java

@@ -0,0 +1,50 @@
+package edu.suffolk.litlab.efsp.model.cases;
+
+import edu.suffolk.litlab.efsp.model.Name;
+import edu.suffolk.litlab.efsp.model.Person;
+import edu.suffolk.litlab.efsp.server.ecf4.EcfCaseTypeFactory;
+import gov.niem.niem.niem_core._2.CaseType;
+import gov.niem.niem.niem_core._2.OrganizationType;
+import gov.niem.niem.niem_core._2.PersonNameType;
+import gov.niem.niem.niem_core._2.PersonType;
+import java.util.Optional;
+import oasis.names.tc.legalxml_courtfiling.schema.xsd.caseresponsemessage_4.CaseResponseMessageType;
+import oasis.names.tc.legalxml_courtfiling.schema.xsd.commontypes_4.CaseParticipantType;
+import tyler.ecf.extensions.common.CaseAugmentationType;
+
+/** A class for parsing ECF types into our internal model types */
+public class ECFToReturn {
+
+  /** TODO: should replace EcfCaseTypeFactory.getCaseParticipants. */
+  public static Name toName(PersonNameType pnt) {
+    var givenName = "";
+    if (pnt.getPersonGivenName() != null) {
+      givenName = pnt.getPersonGivenName().getValue();
+    }
+    var middleName = "";
+    if (pnt.getPersonMiddleName() != null) {
+      middleName = pnt.getPersonMiddleName().getValue();
+    }
+    var surName = "";
+    if (pnt.getPersonSurName() != null) {
+      surName = pnt.getPersonSurName().getValue();
+    }
+    return new Name(givenName, middleName, surName);
+  }
+
+  public static Person toPerson(CaseResponseMessageType resp) {
+    CaseType caseType = resp.getCase().getValue();
+    Optional<CaseAugmentationType> caseAug = EcfCaseTypeFactory.getCaseAugmentation(caseType);
+    CaseParticipantType t = caseAug.get().getCaseParticipant().get(0).getValue();
+    Object o = t.getEntityRepresentation();
+    if (o instanceof OrganizationType ot) {
+
+    } else if (o instanceof PersonType pt) {
+      PersonNameType pnt = pt.getPersonName();
+    }
+
+    return null;
+  }
+
+  // TODO: GetCaseResponseMessageType c;
+}

proxyserver/src/main/java/edu/suffolk/litlab/efsp/model/cases/Person.java

@@ -0,0 +1,22 @@
+package edu.suffolk.litlab.efsp.model.cases;
+
+import edu.suffolk.litlab.efsp.model.ContactInformation;
+import edu.suffolk.litlab.efsp.model.Name;
+
+public class Person {
+  private final Name name;
+  private final ContactInformation contactInfo;
+
+  public Person(Name name, ContactInformation contactInfo) {
+    this.name = name;
+    this.contactInfo = contactInfo;
+  }
+
+  public Name getName() {
+    return name;
+  }
+
+  public ContactInformation getContactInformation() {
+    return contactInfo;
+  }
+}

proxyserver/src/main/java/edu/suffolk/litlab/efsp/server/services/CasesServiceAPI.java

@@ -0,0 +1,81 @@
+package edu.suffolk.litlab.efsp.server.services;
+
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import jakarta.ws.rs.Produces;
+import jakarta.ws.rs.QueryParam;
+import jakarta.ws.rs.core.Context;
+import jakarta.ws.rs.core.HttpHeaders;
+import jakarta.ws.rs.core.MediaType;
+import jakarta.ws.rs.core.Response;
+
+/**
+ * The interface for Case search queries.
+ *
+ * <p>Introduces some abstraction between our current API (returning all raw API info) and a more
+ * structured, culled down version of the API that returns information without all of the silly NIEM
+ * abstractions. Would choose between different versions of the API with a separate X-API-VERSION header.
+ */
+@Produces(MediaType.APPLICATION_JSON)
+public abstract class CasesServiceAPI {
+
+  @GET
+  @Path("/")
+  public abstract Response getAll();
+
+  @GET
+  @Path("/courts")
+  public abstract Response getCourts();
+
+  @GET
+  @Path("/courts/{court_id}")
+  public abstract Response getEndpointsUnderCourt(@PathParam("court_id") String courtId);
+
+  @GET
+  @Path("/courts/{court_id}/cases/{case_tracking_id}/documents")
+  public abstract Response getDocument(
+      @Context HttpHeaders httpHeaders,
+      @PathParam("court_id") String courtId,
+      @PathParam("case_tracking_id") String caseId);
+
+  /** Gets all possible cases associated with either a party's name or a docket number. */
+  @GET
+  @Path("/courts/{court_id}/cases")
+  public abstract Response getCaseList(
+      @Context HttpHeaders httpHeaders,
+      @PathParam("court_id") String courtId,
+      @QueryParam("docket_number") String docketId,
+      @QueryParam("business_name") String businessName,
+      @QueryParam("first_name") String firstName,
+      @QueryParam("middle_name") String middleName,
+      @QueryParam("last_name") String lastName);
+
+  @GET
+  @Path("/courts/{court_id}/cases/{case_tracking_id}")
+  public abstract Response getCase(
+      @Context HttpHeaders httpHeaders,
+      @PathParam("court_id") String courtId,
+      @PathParam("case_tracking_id") String caseId);
+
+  @GET
+  @Path("/courts/{court_id}/service-contacts/{service_contact_id}/cases")
+  public abstract Response getServiceAttachCaseList(
+      @Context HttpHeaders httpHeaders,
+      @PathParam("court_id") String courtId,
+      @PathParam("service_contact_id") String serviceId);
+
+  @GET
+  @Path("/courts/{court_id}/cases/{case_tracking_id}/service-information")
+  public abstract Response getServiceInformation(
+      @Context HttpHeaders httpHeaders,
+      @PathParam("court_id") String courtId,
+      @PathParam("case_tracking_id") String caseId);
+
+  @GET
+  @Path("/courts/{court_id}/cases/{case_tracking_id}/service-information-history")
+  public abstract Response getServiceInformationHistory(
+      @Context HttpHeaders httpHeaders,
+      @PathParam("court_id") String courtId,
+      @PathParam("case_tracking_id") String caseId);
+}

proxyserver/src/test/java/edu/suffolk/litlab/efsp/model/cases/ECFToReturnTest.java

@@ -0,0 +1,21 @@
+package edu.suffolk.litlab.efsp.model.cases;
+
+import gov.niem.niem.niem_core._2.PersonNameType;
+import net.jqwik.api.ForAll;
+import net.jqwik.api.Property;
+import net.jqwik.api.domains.Domain;
+
+public class ECFToReturnTest {
+
+  @Property
+  @Domain(PersonNameExamples.class)
+  boolean allNamesArentBlank(@ForAll PersonNameType pnt) {
+    return !ECFToReturn.toName(pnt).getFullName().isBlank();
+  }
+
+  @Property
+  @Domain(PersonNameExamples.class)
+  boolean allTitlesArentBlank(@ForAll PersonNameType pnt) {
+    return !ECFToReturn.toName(pnt).getTitleName().isBlank();
+  }
+}

proxyserver/src/test/java/edu/suffolk/litlab/efsp/model/cases/PersonNameExamples.java

@@ -0,0 +1,39 @@
+package edu.suffolk.litlab.efsp.model.cases;
+
+import gov.niem.niem.niem_core._2.PersonNameTextType;
+import gov.niem.niem.niem_core._2.PersonNameType;
+import net.jqwik.api.Arbitraries;
+import net.jqwik.api.Arbitrary;
+import net.jqwik.api.Combinators;
+import net.jqwik.api.Provide;
+import net.jqwik.api.domains.DomainContextBase;
+
+public class PersonNameExamples extends DomainContextBase {
+
+  @Provide
+  Arbitrary<PersonNameTextType> nameTexts() {
+    return Arbitraries.strings()
+        .map(
+            (x) -> {
+              var pntt = new PersonNameTextType();
+              pntt.setValue(x);
+              return pntt;
+            });
+  }
+
+  @Provide
+  Arbitrary<PersonNameType> names() {
+    Arbitrary<PersonNameTextType> firsts = Arbitraries.defaultFor(PersonNameTextType.class);
+    Arbitrary<PersonNameTextType> middles = Arbitraries.defaultFor(PersonNameTextType.class);
+    Arbitrary<PersonNameTextType> lasts = Arbitraries.defaultFor(PersonNameTextType.class);
+    return Combinators.combine(firsts, middles, lasts)
+        .as(
+            (f, m, l) -> {
+              var pnt = new PersonNameType();
+              pnt.setPersonGivenName(f);
+              pnt.setPersonMiddleName(m);
+              pnt.setPersonSurName(l);
+              return pnt;
+            });
+  }
+}