cleanup

formkiq · May 29, 2024 · 1229419 · 1229419
1 parent c47da0d
commit 1229419
Show file tree

Hide file tree

Showing 9 changed files with 282 additions and 233 deletions.
diff --git a/aws-dynamodb/src/main/java/com/formkiq/aws/dynamodb/objects/Strings.java b/aws-dynamodb/src/main/java/com/formkiq/aws/dynamodb/objects/Strings.java
@@ -196,6 +196,12 @@ public static String removeQuotes(final String s) {
     return s.replaceAll("^['\"]|['\"]$", "");
   }
 
+  /**
+   * Convert {@link Exception} to {@link String}.
+   * 
+   * @param e {@link Exception}
+   * @return {@link String}
+   */
   public static String toString(final Exception e) {
     StringWriter sw = new StringWriter();
     PrintWriter pw = new PrintWriter(sw);

diff --git a/lambda-s3/src/main/java/com/formkiq/stacks/lambda/s3/DocumentAction.java b/lambda-s3/src/main/java/com/formkiq/stacks/lambda/s3/DocumentAction.java
@@ -46,6 +46,7 @@ public interface DocumentAction {
    * @param actions {@link List} {@link Action}
    * @param action {@link Action}
    * @throws IOException IOException
+   * @throws ValidationException ValidationException
    */
   void run(LambdaLogger logger, String siteId, String documentId, List<Action> actions,
       Action action) throws IOException, ValidationException;

diff --git a/lambda-s3/src/main/java/com/formkiq/stacks/lambda/s3/actions/FullTextAction.java b/lambda-s3/src/main/java/com/formkiq/stacks/lambda/s3/actions/FullTextAction.java
@@ -99,15 +99,15 @@ public void run(final LambdaLogger logger, final String siteId, final String doc
       final List<Action> actions, final Action action) throws IOException {
 
     ActionStatus status = ActionStatus.PENDING;
-    DocumentItem item = documentService.findDocument(siteId, documentId);
+    DocumentItem item = this.documentService.findDocument(siteId, documentId);
     debug(logger, siteId, item);
 
     List<String> contentUrls =
-        documentContentFunc.getContentUrls(this.debug ? logger : null, siteId, item);
+        this.documentContentFunc.getContentUrls(this.debug ? logger : null, siteId, item);
 
     if (!contentUrls.isEmpty()) {
 
-      if (moduleFulltext) {
+      if (this.moduleFulltext) {
 
         try {
           updateOpensearchFulltext(siteId, documentId, contentUrls);
@@ -118,8 +118,8 @@ public void run(final LambdaLogger logger, final String siteId, final String doc
         status = ActionStatus.COMPLETE;
       }
 
-      if (moduleTypesense) {
-        updateTypesense(documentContentFunc, siteId, documentId, action, contentUrls);
+      if (this.moduleTypesense) {
+        updateTypesense(this.documentContentFunc, siteId, documentId, action, contentUrls);
         status = ActionStatus.COMPLETE;
       }
 
@@ -131,7 +131,7 @@ public void run(final LambdaLogger logger, final String siteId, final String doc
 
       Action ocrAction = new Action().userId("System").type(ActionType.OCR)
           .parameters(Map.of("ocrEngine", "tesseract"));
-      actionsService.insertBeforeAction(siteId, documentId, actions, action, ocrAction);
+      this.actionsService.insertBeforeAction(siteId, documentId, actions, action, ocrAction);
 
       this.notificationService.publishNextActionEvent(siteId, documentId);
 
@@ -140,7 +140,7 @@ public void run(final LambdaLogger logger, final String siteId, final String doc
     }
 
     action.status(status);
-    actionsService.updateActionStatus(siteId, documentId, action);
+    this.actionsService.updateActionStatus(siteId, documentId, action);
   }
 
   private void debug(final LambdaLogger logger, final String siteId, final DocumentItem item) {
@@ -220,7 +220,8 @@ private void updateTypesense(final DocumentContentFunction dcFunc, final String
 
       Map<String, Object> document = new DocumentMapToDocument().apply(data);
 
-      HttpResponse<String> response = typesense.addOrUpdateDocument(siteId, documentId, document);
+      HttpResponse<String> response =
+          this.typesense.addOrUpdateDocument(siteId, documentId, document);
 
       if (!is2XX(response)) {
         throw new IOException(response.body());

diff --git a/lambda-s3/src/main/java/com/formkiq/stacks/lambda/s3/actions/IdpAction.java b/lambda-s3/src/main/java/com/formkiq/stacks/lambda/s3/actions/IdpAction.java
@@ -130,7 +130,7 @@ private String getMetadataText(final MappingAttribute mappingAttribute, final St
       final String documentId) {
     String text;
 
-    DocumentItem document = documentService.findDocument(siteId, documentId);
+    DocumentItem document = this.documentService.findDocument(siteId, documentId);
 
     MappingAttributeMetadataField metadataField = mappingAttribute.getMetadataField();
     switch (metadataField) {
@@ -229,16 +229,16 @@ private TextMatchAlgorithm getTextMatchAlgorithm(final MappingAttribute mappingA
 
   private String getDocumentContent(final LambdaLogger logger, final String siteId,
       final String documentId) throws IOException {
-    DocumentItem item = documentService.findDocument(siteId, documentId);
+    DocumentItem item = this.documentService.findDocument(siteId, documentId);
 
     List<String> contentUrls =
-        documentContentFunc.getContentUrls(this.debug ? logger : null, siteId, item);
-    StringBuilder sb = documentContentFunc.getContentUrls(contentUrls);
+        this.documentContentFunc.getContentUrls(this.debug ? logger : null, siteId, item);
+    StringBuilder sb = this.documentContentFunc.getContentUrls(contentUrls);
     return sb.toString();
   }
 
   private MappingRecord getMapping(final String siteId, final String mappingId) throws IOException {
-    MappingRecord mapping = mappingService.getMapping(siteId, mappingId);
+    MappingRecord mapping = this.mappingService.getMapping(siteId, mappingId);
     if (mapping == null) {
       throw new IOException("Mapping '" + mappingId + "' not found");
     }

diff --git a/lambda-s3/src/main/java/com/formkiq/stacks/lambda/s3/actions/SendHttpRequest.java b/lambda-s3/src/main/java/com/formkiq/stacks/lambda/s3/actions/SendHttpRequest.java
@@ -51,6 +51,15 @@ public SendHttpRequest(final AwsServiceCache serviceCache) {
     this.documentsIamUrl = serviceCache.environment("documentsIamUrl");
   }
 
+  /**
+   * Send Http Request.
+   * 
+   * @param siteId {@link String}
+   * @param method {@link String}
+   * @param url {@link String}
+   * @param payload {@link String}
+   * @throws IOException IOException
+   */
   public void sendRequest(final String siteId, final String method, final String url,
       final String payload) throws IOException {
 
@@ -64,11 +73,11 @@ public void sendRequest(final String siteId, final String method, final String u
 
     HttpResponse<String> response;
     if ("put".equalsIgnoreCase(method)) {
-      response = http.put(u, Optional.empty(), parameters, payload);
+      response = this.http.put(u, Optional.empty(), parameters, payload);
     } else if ("post".equalsIgnoreCase(method)) {
-      response = http.post(u, Optional.empty(), parameters, payload);
+      response = this.http.post(u, Optional.empty(), parameters, payload);
     } else if ("patch".equalsIgnoreCase(method)) {
-      response = http.patch(u, Optional.empty(), parameters, payload);
+      response = this.http.patch(u, Optional.empty(), parameters, payload);
     } else {
       throw new UnsupportedOperationException("unsupported method '" + method + "'");
     }

diff --git a/lambda-s3/src/main/java/com/formkiq/stacks/lambda/s3/text/TextMatchScoreComparator.java b/lambda-s3/src/main/java/com/formkiq/stacks/lambda/s3/text/TextMatchScoreComparator.java
@@ -31,6 +31,9 @@
  */
 public class TextMatchScoreComparator implements Comparator<TextMatch>, Serializable {
 
+  /** Serial Version UID. */
+  private static final long serialVersionUID = -9124636645063016390L;
+
   @Override
   public int compare(final TextMatch o1, final TextMatch o2) {
     return Integer.compare(o1.getScore(), o2.getScore());

diff --git a/lambda-s3/src/main/java/com/formkiq/stacks/lambda/s3/text/TokenGeneratorDefault.java b/lambda-s3/src/main/java/com/formkiq/stacks/lambda/s3/text/TokenGeneratorDefault.java
@@ -53,6 +53,7 @@ public String formatText(final String text) {
     return text.toLowerCase().replaceAll("\\p{Punct}", "").replaceAll(ALPHANUMERIC, " ");
   }
 
+  @Override
   public String getSplitRegex() {
     return "\\s+";
   }