diff --git a/src/core/pom.xml b/src/core/pom.xml index e364db0..79623a0 100644 --- a/src/core/pom.xml +++ b/src/core/pom.xml @@ -108,19 +108,23 @@ - + diff --git a/src/core/src/main/kotlin/Configuration.kt b/src/core/src/main/kotlin/Configuration.kt index d40f653..2aa3228 100644 --- a/src/core/src/main/kotlin/Configuration.kt +++ b/src/core/src/main/kotlin/Configuration.kt @@ -26,6 +26,10 @@ object Configuration { /** The connection string for the JDBC connection */ @JvmStatic var connectionString: String? = null + /** + * Set a value for the connection string + * @param value The connection string to set + */ set(value) { field = value dialectValue = if (value.isNullOrBlank()) null else Dialect.deriveFromConnectionString(value) diff --git a/src/core/src/main/kotlin/java/Custom.kt b/src/core/src/main/kotlin/java/Custom.kt index f341153..b90d963 100644 --- a/src/core/src/main/kotlin/java/Custom.kt +++ b/src/core/src/main/kotlin/java/Custom.kt @@ -9,6 +9,9 @@ import java.sql.SQLException import java.util.* import kotlin.jvm.Throws +/** + * Functions to run custom queries + */ object Custom { /** diff --git a/src/core/src/main/kotlin/java/Results.kt b/src/core/src/main/kotlin/java/Results.kt index d79b533..553329a 100644 --- a/src/core/src/main/kotlin/java/Results.kt +++ b/src/core/src/main/kotlin/java/Results.kt @@ -7,6 +7,9 @@ import java.sql.PreparedStatement import java.sql.ResultSet import java.sql.SQLException +/** + * Functions to create results from queries + */ object Results { /** diff --git a/src/core/src/main/module-info.md b/src/core/src/main/module-info.md new file mode 100644 index 0000000..158ae4b --- /dev/null +++ b/src/core/src/main/module-info.md @@ -0,0 +1,19 @@ +# Module core + +This module contains configuration and support files for the document store API, as well as an implementation suitable for any JVM language. + +# Package solutions.bitbadger.documents + +Configuration and other items to support the document store API + +# Package solutions.bitbadger.documents.query + +Functions to create document manipulation queries + +# Package solutions.bitbadger.documents.java + +A Java-focused implementation of the document store API + +# Package solutions.bitbadger.documents.java.extensions + +Extensions on the Java `Connection` object for document manipulation diff --git a/src/groovy/pom.xml b/src/groovy/pom.xml index 0289ee4..ef52157 100644 --- a/src/groovy/pom.xml +++ b/src/groovy/pom.xml @@ -103,6 +103,19 @@ + + org.apache.maven.plugins + maven-javadoc-plugin + ${javaDocPlugin.version} + + + attach-javadocs + + jar + + + + diff --git a/src/groovy/src/main/java/module-info.java b/src/groovy/src/main/java/module-info.java index 4bba727..80da45b 100644 --- a/src/groovy/src/main/java/module-info.java +++ b/src/groovy/src/main/java/module-info.java @@ -1,3 +1,7 @@ +/** + * This module registers the Kotlin extension methods for the JDBC Connection object with the Groovy + * runtime + */ module solutions.bitbadger.documents.groovy { requires solutions.bitbadger.documents.core; } diff --git a/src/groovy/src/main/java/solutions/bitbadger/documents/groovy/NoClassesHere.java b/src/groovy/src/main/java/solutions/bitbadger/documents/groovy/NoClassesHere.java new file mode 100644 index 0000000..cead2b1 --- /dev/null +++ b/src/groovy/src/main/java/solutions/bitbadger/documents/groovy/NoClassesHere.java @@ -0,0 +1,7 @@ +package solutions.bitbadger.documents.groovy; + +/** + * This library has no classes; it only updates Groovy's configuration + */ +public interface NoClassesHere { +} diff --git a/src/groovy/src/main/java/solutions/bitbadger/documents/groovy/package-info.java b/src/groovy/src/main/java/solutions/bitbadger/documents/groovy/package-info.java new file mode 100644 index 0000000..fed9331 --- /dev/null +++ b/src/groovy/src/main/java/solutions/bitbadger/documents/groovy/package-info.java @@ -0,0 +1,11 @@ +/** + * Groovy extensions on the JDBC Connection object exposing a document store API + *

+ * This package wires up the core extensions to work in Groovy. No imports are needed, and the + * documentation for the solutions.bitbadger.documents.java.extensions package applies to those extensions + * as well. + *

+ * For example, finding all documents in a table, using the document manipulation functions, looks something like + * Find.all(tableName, conn); with the extensions, this becomes conn.findAll(tableName). + */ +package solutions.bitbadger.documents.groovy; diff --git a/src/kotlinx/pom.xml b/src/kotlinx/pom.xml index f2974dc..d19c981 100644 --- a/src/kotlinx/pom.xml +++ b/src/kotlinx/pom.xml @@ -139,6 +139,23 @@ + + org.jetbrains.dokka + dokka-maven-plugin + 2.0.0 + + true + ${project.basedir}/src/main/module-info.md + + + + package + + javadocJar + + + + diff --git a/src/kotlinx/src/main/module-info.md b/src/kotlinx/src/main/module-info.md new file mode 100644 index 0000000..92e1012 --- /dev/null +++ b/src/kotlinx/src/main/module-info.md @@ -0,0 +1,11 @@ +# Module kotlinx + +This module contains an implementation of the document store API which uses a `kotlinx.serialization`-based serializer (relies on reified generics) + +# Package solutions.bitbadger.documents.kotlinx + +The document store API based on `kotlinx.serialization` + +# Package solutions.bitbadger.documents.kotlinx.extensions + +Extensions on the Java `Connection` object for document manipulation diff --git a/src/scala/pom.xml b/src/scala/pom.xml index 8dc88a8..6a8aa83 100644 --- a/src/scala/pom.xml +++ b/src/scala/pom.xml @@ -32,6 +32,13 @@ testCompile + ${java.version} @@ -63,24 +70,6 @@ ${java.version} - org.apache.maven.plugins maven-source-plugin