Added new details and configurations for v0.1.2

Author: herminiogg

README.md

@@ -29,34 +29,56 @@ section.
 
 # CLI
 ```
-Usage: dmaog [-hV] [-dr=<drivers>] -m=<mappingRules> [-ml=<mappingLanguage>]
-    -o=<outputPath> -p=<packageName> [-ps=<password>] [-u=<username>]
+Usage: dmaog [-hV] [--static] [-dr=<drivers>] [-m=<mappingRules>]
+             [-ml=<mappingLanguage>] -o=<outputPath> -p=<packageName>
+             [-ps=<password>] [-se=<sparqlEndpoint>] [-u=<username>]
 Generate data access objects and services from your mapping rules.
-    -dr, --drivers=<drivers>
-        Drivers string in case it is not included in ShExML
-    -h, --help      Show this help message and exit.
-    -m, --mapping=<mappingRules>
-        Path to the file with the mappings
-    -ml, --mappingLanguage=<mappingLanguage>
-        Mapping language to use: ShExML or RML
-    -o, --output=<outputPath>
-        Path where to generate the output files
-    -p, --package=<packageName>
-        Package information for the generated files
-    -ps, --password=<password>
-        Password in case of database connection
-    -u, --username=<username>
-        Username in case of database connection
-    -V, --version   Print version information and exit.
+      -dr, --drivers=<drivers>
+                  Drivers string in case it is not included in ShExML
+  -h, --help      Show this help message and exit.
+  -m, --mapping=<mappingRules>
+                  Path to the file with the mappings
+      -ml, --mappingLanguage=<mappingLanguage>
+                  Mapping language to use: ShExML or RML
+  -o, --output=<outputPath>
+                  Path where to generate the output files
+  -p, --package=<packageName>
+                  Package information for the generated files
+      -ps, --password=<password>
+                  Password in case of database connection
+      -se, --sparqlEndpoint=<sparqlEndpoint>
+                  URL pointing to the SPARQL endpoint
+      --static    Exploit mapping rules without executing them
+  -u, --username=<username>
+                  Username in case of database connection
+  -V, --version   Print version information and exit.
 ```
 
+# Supported features
+* Generation of data against files and SPARQL endpoints
+* Using already existing data files and SPARQL endpoints without mapping rules
+* Update actions on files and SPARQL endpoints (without authentication)
+* Static analysis of ShExML rules (not need to run the mapping rules to generate classes)
+* Multilingual strings
+* Pagination of the results
+
 # Supported methods in services
 * getAll(): List[Type] -> Returns all the results for the type
+* getAll(Long limit, Long offset): List[Type] -> Returns all the results for the type within the given page
+* getAll(String rdfFormat): String -> Returns all the results in the requested format
+* count(): Long -> Returns the total number of objects of this type
 * getById(String id): Type -> Return the object with the given id for the type. Take into account that the id is refering
 to the local part of the subject URI when talking about RDF data.
+* getById(String id, String rdfFormat): String  -> Return the object with the given id in the requested format.
 * getByField(String fieldName, String value): List<Type> -> Return all the results whose indicated field value matches with
 the given value. Take into account that the fieldName refers to the localPart of the predicate URI when talking about RDF data.
+* getByField(String fieldName, String value, String rdfFormat): String -> Return all the results whose indicated field 
+value matches with the given value in the requested format.
+* commit(Type instance) -> Deletes the instance (if it exists) in the data store and inserts the new data. It can act 
+as create or update method.
+* delete(Type instance) -> Deletes the instance in the data store.
 
 # Future work
-* Support for Triple Stores and for data modification actions 
-* Possibility to use Shapes for code generation
+* Support for authentication on update actions against SPARQL endpoints
+* Possibility to use Shapes for code generation
+* Static analysis of RML rules

build.sbt

@@ -4,7 +4,7 @@ lazy val dmaog = project
   .in(file("."))
   .settings(
     name := "DMAOG",
-    version := "0.1.1",
+    version := "0.1.2",
     scalaVersion := "3.2.0",
     crossScalaVersions := Seq("2.12.17", "2.13.9", "3.2.0"),
     libraryDependencies ++= Seq(
@@ -21,6 +21,7 @@ lazy val dmaog = project
       "org.apache.jena" % "apache-jena-libs" % "3.8.0"
     ),
     assembly / assemblyMergeStrategy := {
+      case PathList("META-INF", "services", xs @ _*) => MergeStrategy.concat
       case PathList("META-INF", xs @ _*) => MergeStrategy.discard
       case x => MergeStrategy.first
     }

publish.sbt

@@ -1,15 +1,15 @@
-organization in ThisBuild := "com.herminiogarcia"
-organizationName in ThisBuild := "herminiogarcia"
-organizationHomepage in ThisBuild := Some(url("https://herminiogarcia.com"))
+ThisBuild / organization := "com.herminiogarcia"
+ThisBuild / organizationName := "herminiogarcia"
+ThisBuild /organizationHomepage := Some(url("https://herminiogarcia.com"))
 
-scmInfo in ThisBuild := Some(
+ThisBuild / scmInfo := Some(
   ScmInfo(
     url("https://github.com/herminiogg/dmaog"),
     "scm:[email protected]:herminiogg/dmaog.git"
   )
 )
 
-developers in ThisBuild := List(
+ThisBuild / developers := List(
   Developer(
     id    = "herminiogg",
     name  = "Herminio Garcia Gonzalez",
@@ -18,17 +18,17 @@ developers in ThisBuild := List(
   )
 )
 
-description in ThisBuild := "Data Mapping Access Objects Generator (DMAOG)"
-licenses in ThisBuild := List("MIT License" -> new URL("https://opensource.org/licenses/MIT"))
-homepage in ThisBuild := Some(url("https://github.com/herminiogg/dmaog"))
+ThisBuild / description := "Data Mapping Access Objects Generator (DMAOG)"
+ThisBuild / licenses := List("MIT License" -> new URL("https://opensource.org/licenses/MIT"))
+ThisBuild / homepage := Some(url("https://github.com/herminiogg/dmaog"))
 
 // Remove all additional repository other than Maven Central from POM
-pomIncludeRepository in ThisBuild := { _ => false }
+ThisBuild / pomIncludeRepository := { _ => false }
 
-publishTo in ThisBuild := {
+ThisBuild / publishTo := {
   val nexus = "https://s01.oss.sonatype.org/"
   if (isSnapshot.value) Some("snapshots" at nexus + "content/repositories/snapshots")
   else Some("releases" at nexus + "service/local/staging/deploy/maven2")
 }
 
-publishMavenStyle in ThisBuild := true
+ThisBuild / publishMavenStyle := true

src/main/scala/com/herminiogarcia/dmaog/Main.scala

@@ -16,7 +16,7 @@ object Main {
 
 }
 
-@Command(name = "dmaog", version = Array("v0.1.1"),
+@Command(name = "dmaog", version = Array("v0.1.2"),
   mixinStandardHelpOptions = true,
   description = Array("Generate data access objects and services from your mapping rules."))
 class Main extends Callable[Int] {