Reorganize and clean up code

schemacrawler-ai-core/src/main/java/module-info.java

@@ -1,14 +1,14 @@
 module us.fatehi.schemacrawler.ai_core {
   // Dependencies
-  requires us.fatehi.schemacrawler.schemacrawler;
+  requires transitive us.fatehi.schemacrawler.schemacrawler;
   requires us.fatehi.schemacrawler.scripting;
   requires us.fatehi.schemacrawler.offline;
   requires us.fatehi.schemacrawler.lint;
   requires java.logging;
   requires java.sql;
   requires com.fasterxml.jackson.module.jsonSchema;
   requires com.fasterxml.jackson.core;
-  requires com.fasterxml.jackson.databind;
+  requires transitive com.fasterxml.jackson.databind;
 
   // Export only the public API packages
   exports schemacrawler.tools.ai.tools;

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/DescribeRoutinesFunctionDefinition.java

@@ -8,7 +8,7 @@
 
 package schemacrawler.tools.ai.functions;
 
-import schemacrawler.tools.ai.tools.AbstractFunctionDefinition;
+import schemacrawler.tools.ai.tools.base.AbstractFunctionDefinition;
 
 public final class DescribeRoutinesFunctionDefinition
     extends AbstractFunctionDefinition<DescribeRoutinesFunctionParameters> {

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/DescribeRoutinesFunctionExecutor.java

@@ -24,6 +24,7 @@
 import schemacrawler.tools.ai.model.CatalogDocument;
 import schemacrawler.tools.ai.model.CompactCatalogUtility;
 import schemacrawler.tools.ai.tools.JsonFunctionReturn;
+import schemacrawler.tools.ai.tools.base.AbstractJsonFunctionExecutor;
 import us.fatehi.utility.property.PropertyName;
 
 public final class DescribeRoutinesFunctionExecutor

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/DescribeRoutinesFunctionParameters.java

@@ -18,7 +18,7 @@
 import schemacrawler.tools.ai.model.AdditionalRoutineDetails;
 import schemacrawler.tools.ai.tools.FunctionParameters;
 import schemacrawler.tools.ai.tools.FunctionReturnType;
-import schemacrawler.tools.ai.utility.JsonUtility;
+import schemacrawler.tools.ai.tools.base.ParameterUtility;
 
 @JsonNaming(PropertyNamingStrategies.KebabCaseStrategy.class)
 public record DescribeRoutinesFunctionParameters(
@@ -72,7 +72,7 @@ public AdditionalRoutineDetails toAdditionalRoutineDetails() {
 
   @Override
   public String toString() {
-    return JsonUtility.parametersToString(this);
+    return ParameterUtility.parametersToString(this);
   }
 
   @JsonIgnore

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/DescribeTablesFunctionDefinition.java

@@ -8,7 +8,7 @@
 
 package schemacrawler.tools.ai.functions;
 
-import schemacrawler.tools.ai.tools.AbstractFunctionDefinition;
+import schemacrawler.tools.ai.tools.base.AbstractFunctionDefinition;
 
 public final class DescribeTablesFunctionDefinition
     extends AbstractFunctionDefinition<DescribeTablesFunctionParameters> {

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/DescribeTablesFunctionExecutor.java

@@ -13,6 +13,7 @@
 import java.util.ArrayList;
 import java.util.Collection;
 import schemacrawler.inclusionrule.ExcludeAll;
+import schemacrawler.inclusionrule.IncludeAll;
 import schemacrawler.inclusionrule.InclusionRule;
 import schemacrawler.schemacrawler.GrepOptionsBuilder;
 import schemacrawler.schemacrawler.LimitOptionsBuilder;
@@ -23,6 +24,7 @@
 import schemacrawler.tools.ai.model.CatalogDocument;
 import schemacrawler.tools.ai.model.CompactCatalogUtility;
 import schemacrawler.tools.ai.tools.JsonFunctionReturn;
+import schemacrawler.tools.ai.tools.base.AbstractJsonFunctionExecutor;
 import us.fatehi.utility.property.PropertyName;
 
 public final class DescribeTablesFunctionExecutor
@@ -62,7 +64,8 @@ protected SchemaCrawlerOptions createSchemaCrawlerOptions() {
         LimitOptionsBuilder.builder()
             .includeSynonyms(new ExcludeAll())
             .includeSequences(new ExcludeAll())
-            .includeRoutines(new ExcludeAll());
+            .includeRoutines(new ExcludeAll())
+            .includeTables(new IncludeAll());
     final InclusionRule grepTablesPattern = makeInclusionRule(commandOptions.tableName());
     final GrepOptionsBuilder grepOptionsBuilder =
         GrepOptionsBuilder.builder().includeGreppedTables(grepTablesPattern);

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/DescribeTablesFunctionParameters.java

@@ -18,7 +18,7 @@
 import schemacrawler.tools.ai.model.AdditionalTableDetails;
 import schemacrawler.tools.ai.tools.FunctionParameters;
 import schemacrawler.tools.ai.tools.FunctionReturnType;
-import schemacrawler.tools.ai.utility.JsonUtility;
+import schemacrawler.tools.ai.tools.base.ParameterUtility;
 
 @JsonNaming(PropertyNamingStrategies.KebabCaseStrategy.class)
 public record DescribeTablesFunctionParameters(
@@ -79,7 +79,7 @@ public AdditionalTableDetails toAdditionalTableDetails() {
 
   @Override
   public String toString() {
-    return JsonUtility.parametersToString(this);
+    return ParameterUtility.parametersToString(this);
   }
 
   @JsonIgnore

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/LintFunctionDefinition.java

@@ -8,7 +8,7 @@
 
 package schemacrawler.tools.ai.functions;
 
-import schemacrawler.tools.ai.tools.AbstractFunctionDefinition;
+import schemacrawler.tools.ai.tools.base.AbstractFunctionDefinition;
 
 public final class LintFunctionDefinition
     extends AbstractFunctionDefinition<LintFunctionParameters> {

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/LintFunctionExecutor.java

@@ -9,7 +9,7 @@
 package schemacrawler.tools.ai.functions;
 
 import schemacrawler.inclusionrule.InclusionRule;
-import schemacrawler.tools.ai.tools.AbstractExecutableFunctionExecutor;
+import schemacrawler.tools.ai.tools.base.AbstractExecutableFunctionExecutor;
 import us.fatehi.utility.property.PropertyName;
 
 public final class LintFunctionExecutor

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/LintFunctionParameters.java

@@ -15,7 +15,7 @@
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
 import schemacrawler.tools.ai.tools.FunctionParameters;
 import schemacrawler.tools.ai.tools.FunctionReturnType;
-import schemacrawler.tools.ai.utility.JsonUtility;
+import schemacrawler.tools.ai.tools.base.ParameterUtility;
 
 @JsonNaming(PropertyNamingStrategies.KebabCaseStrategy.class)
 public record LintFunctionParameters(
@@ -39,7 +39,7 @@ table name (including the schema).
 
   @Override
   public String toString() {
-    return JsonUtility.parametersToString(this);
+    return ParameterUtility.parametersToString(this);
   }
 
   @JsonIgnore

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/ListAcrossTablesFunctionDefinition.java

@@ -8,7 +8,7 @@
 
 package schemacrawler.tools.ai.functions;
 
-import schemacrawler.tools.ai.tools.AbstractFunctionDefinition;
+import schemacrawler.tools.ai.tools.base.AbstractFunctionDefinition;
 
 public final class ListAcrossTablesFunctionDefinition
     extends AbstractFunctionDefinition<ListAcrossTablesFunctionParameters> {

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/ListAcrossTablesFunctionExecutor.java

@@ -34,6 +34,7 @@
 import schemacrawler.tools.ai.model.IndexDocument;
 import schemacrawler.tools.ai.model.TriggerDocument;
 import schemacrawler.tools.ai.tools.JsonFunctionReturn;
+import schemacrawler.tools.ai.tools.base.AbstractJsonFunctionExecutor;
 import us.fatehi.utility.property.PropertyName;
 
 public final class ListAcrossTablesFunctionExecutor

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/ListAcrossTablesFunctionParameters.java

@@ -17,7 +17,7 @@
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
 import schemacrawler.tools.ai.tools.FunctionParameters;
 import schemacrawler.tools.ai.tools.FunctionReturnType;
-import schemacrawler.tools.ai.utility.JsonUtility;
+import schemacrawler.tools.ai.tools.base.ParameterUtility;
 
 @JsonNaming(PropertyNamingStrategies.KebabCaseStrategy.class)
 public record ListAcrossTablesFunctionParameters(
@@ -80,7 +80,7 @@ public String nameAttribute() {
 
   @Override
   public String toString() {
-    return JsonUtility.parametersToString(this);
+    return ParameterUtility.parametersToString(this);
   }
 
   @JsonIgnore

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/ListFunctionDefinition.java

@@ -8,7 +8,7 @@
 
 package schemacrawler.tools.ai.functions;
 
-import schemacrawler.tools.ai.tools.AbstractFunctionDefinition;
+import schemacrawler.tools.ai.tools.base.AbstractFunctionDefinition;
 
 public final class ListFunctionDefinition
     extends AbstractFunctionDefinition<ListFunctionParameters> {

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/ListFunctionExecutor.java

@@ -25,6 +25,7 @@
 import schemacrawler.tools.ai.model.DatabaseObjectDocument;
 import schemacrawler.tools.ai.model.DatabaseObjectType;
 import schemacrawler.tools.ai.tools.JsonFunctionReturn;
+import schemacrawler.tools.ai.tools.base.AbstractJsonFunctionExecutor;
 import us.fatehi.utility.property.PropertyName;
 
 public final class ListFunctionExecutor

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/ListFunctionParameters.java

@@ -18,7 +18,7 @@
 import schemacrawler.tools.ai.model.DatabaseObjectType;
 import schemacrawler.tools.ai.tools.FunctionParameters;
 import schemacrawler.tools.ai.tools.FunctionReturnType;
-import schemacrawler.tools.ai.utility.JsonUtility;
+import schemacrawler.tools.ai.tools.base.ParameterUtility;
 
 @JsonNaming(PropertyNamingStrategies.KebabCaseStrategy.class)
 public record ListFunctionParameters(
@@ -51,7 +51,7 @@ database object name (including the schema). May match
 
   @Override
   public String toString() {
-    return JsonUtility.parametersToString(this);
+    return ParameterUtility.parametersToString(this);
   }
 
   @JsonIgnore

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/ServerInformationFunctionDefinition.java

@@ -8,8 +8,8 @@
 
 package schemacrawler.tools.ai.functions;
 
-import schemacrawler.tools.ai.tools.AbstractFunctionDefinition;
 import schemacrawler.tools.ai.tools.NoParameters;
+import schemacrawler.tools.ai.tools.base.AbstractFunctionDefinition;
 
 public final class ServerInformationFunctionDefinition
     extends AbstractFunctionDefinition<NoParameters> {

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/ServerInformationFunctionExecutor.java

@@ -18,6 +18,7 @@
 import schemacrawler.schemacrawler.SchemaCrawlerOptionsBuilder;
 import schemacrawler.tools.ai.tools.JsonFunctionReturn;
 import schemacrawler.tools.ai.tools.NoParameters;
+import schemacrawler.tools.ai.tools.base.AbstractJsonFunctionExecutor;
 import us.fatehi.utility.property.Property;
 import us.fatehi.utility.property.PropertyName;
 

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/TableSampleFunctionDefinition.java

@@ -8,7 +8,7 @@
 
 package schemacrawler.tools.ai.functions;
 
-import schemacrawler.tools.ai.tools.AbstractFunctionDefinition;
+import schemacrawler.tools.ai.tools.base.AbstractFunctionDefinition;
 
 public final class TableSampleFunctionDefinition
     extends AbstractFunctionDefinition<TableSampleFunctionParameters> {

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/TableSampleFunctionExecutor.java

@@ -9,7 +9,7 @@
 package schemacrawler.tools.ai.functions;
 
 import schemacrawler.inclusionrule.InclusionRule;
-import schemacrawler.tools.ai.tools.AbstractExecutableFunctionExecutor;
+import schemacrawler.tools.ai.tools.base.AbstractExecutableFunctionExecutor;
 import us.fatehi.utility.property.PropertyName;
 
 public final class TableSampleFunctionExecutor

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/TableSampleFunctionParameters.java

@@ -15,7 +15,7 @@
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
 import schemacrawler.tools.ai.tools.FunctionParameters;
 import schemacrawler.tools.ai.tools.FunctionReturnType;
-import schemacrawler.tools.ai.utility.JsonUtility;
+import schemacrawler.tools.ai.tools.base.ParameterUtility;
 
 @JsonNaming(PropertyNamingStrategies.KebabCaseStrategy.class)
 public record TableSampleFunctionParameters(
@@ -39,7 +39,7 @@ table name (including the schema).
 
   @Override
   public String toString() {
-    return JsonUtility.parametersToString(this);
+    return ParameterUtility.parametersToString(this);
   }
 
   @JsonIgnore

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/tools/FunctionCallback.java

@@ -30,7 +30,7 @@ public final class FunctionCallback<P extends FunctionParameters> {
 
   private static final Logger LOGGER = Logger.getLogger(FunctionCallback.class.getCanonicalName());
 
-  private FunctionDefinition<P> functionDefinition;
+  private final FunctionDefinition<P> functionDefinition;
   private final Catalog catalog;
 
   /**

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/tools/AbstractExecutableFunctionExecutor.java → schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/tools/base/AbstractExecutableFunctionExecutor.java

@@ -6,21 +6,25 @@
  * SPDX-License-Identifier: CC-BY-NC-4.0
  */
 
-package schemacrawler.tools.ai.tools;
+package schemacrawler.tools.ai.tools.base;
 
 import static schemacrawler.tools.ai.utility.JsonUtility.mapper;
-
-import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.node.ObjectNode;
 import java.io.StringWriter;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
 import schemacrawler.inclusionrule.ExcludeAll;
 import schemacrawler.inclusionrule.InclusionRule;
 import schemacrawler.schemacrawler.GrepOptionsBuilder;
 import schemacrawler.schemacrawler.LimitOptionsBuilder;
 import schemacrawler.schemacrawler.SchemaCrawlerOptions;
 import schemacrawler.schemacrawler.SchemaCrawlerOptionsBuilder;
+import schemacrawler.tools.ai.tools.FunctionParameters;
+import schemacrawler.tools.ai.tools.FunctionReturn;
+import schemacrawler.tools.ai.tools.FunctionReturnType;
+import schemacrawler.tools.ai.tools.JsonFunctionReturn;
+import schemacrawler.tools.ai.tools.TextFunctionReturn;
 import schemacrawler.tools.command.text.schema.options.SchemaTextOptionsBuilder;
 import schemacrawler.tools.executable.SchemaCrawlerExecutable;
 import schemacrawler.tools.options.Config;

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/tools/AbstractFunctionDefinition.java → schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/tools/base/AbstractFunctionDefinition.java

@@ -6,17 +6,20 @@
  * SPDX-License-Identifier: CC-BY-NC-4.0
  */
 
-package schemacrawler.tools.ai.tools;
+package schemacrawler.tools.ai.tools.base;
 
 import static schemacrawler.tools.ai.utility.JsonUtility.mapper;
-
 import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.PropertyNamingStrategies.KebabCaseStrategy;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import schemacrawler.tools.ai.tools.FunctionDefinition;
+import schemacrawler.tools.ai.tools.FunctionParameters;
 
 public abstract class AbstractFunctionDefinition<P extends FunctionParameters>
     implements FunctionDefinition<P> {
 
-  private String toString;
+  private JsonNode definition;
 
   @JsonIgnore
   @Override
@@ -32,26 +35,18 @@ public final String getName() {
 
   @Override
   public String toString() {
-    buildToString();
-    return toString;
+    if (definition == null) {
+      definition = buildDefinition();
+    }
+    return definition.toPrettyString();
   }
 
-  private void buildToString() {
-    if (toString != null) {
-      return;
-    }
+  private JsonNode buildDefinition() {
+    final ObjectNode objectNode = mapper.createObjectNode();
 
-    String parameters;
-    try {
-      final FunctionParameters parametersObject =
-          getParametersClass().getDeclaredConstructor().newInstance();
-      parameters = mapper.writeValueAsString(parametersObject);
-    } catch (final Exception e) {
-      parameters =
-          new KebabCaseStrategy()
-              .translate(getParametersClass().getSimpleName())
-              .replace("-function-parameters", "");
-    }
-    toString = String.format("function %s%n\"%s\"%n%s", getName(), getDescription(), parameters);
+    objectNode.put("name", getName());
+    objectNode.put("description", getDescription());
+
+    return objectNode;
   }
 }

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/tools/AbstractFunctionExecutor.java → schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/tools/base/AbstractFunctionExecutor.java

@@ -6,7 +6,7 @@
  * SPDX-License-Identifier: CC-BY-NC-4.0
  */
 
-package schemacrawler.tools.ai.tools;
+package schemacrawler.tools.ai.tools.base;
 
 import static java.util.Objects.requireNonNull;
 import static us.fatehi.utility.Utility.isBlank;
@@ -16,6 +16,9 @@
 import schemacrawler.inclusionrule.InclusionRule;
 import schemacrawler.inclusionrule.RegularExpressionInclusionRule;
 import schemacrawler.schemacrawler.SchemaCrawlerOptions;
+import schemacrawler.tools.ai.tools.FunctionExecutor;
+import schemacrawler.tools.ai.tools.FunctionParameters;
+import schemacrawler.tools.ai.tools.FunctionReturn;
 import schemacrawler.tools.executable.BaseCommand;
 import us.fatehi.utility.property.PropertyName;
 

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/AbstractJsonFunctionExecutor.java → schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/tools/base/AbstractJsonFunctionExecutor.java

@@ -6,10 +6,9 @@
  * SPDX-License-Identifier: CC-BY-NC-4.0
  */
 
-package schemacrawler.tools.ai.functions;
+package schemacrawler.tools.ai.tools.base;
 
 import schemacrawler.schemacrawler.SchemaCrawlerOptions;
-import schemacrawler.tools.ai.tools.AbstractFunctionExecutor;
 import schemacrawler.tools.ai.tools.FunctionParameters;
 import schemacrawler.tools.ai.tools.JsonFunctionReturn;
 import schemacrawler.utility.MetaDataUtility;