From 955b34328e05b42548d4fce942968fd122840d6e Mon Sep 17 00:00:00 2001 From: woemler Date: Sat, 19 Mar 2016 10:18:22 -0400 Subject: [PATCH] Updated docs with Maven artifacts. --- README.md | 28 +++++++++++++++++++++++++++- centromere-core/README.md | 12 ++++++++++++ centromere-mongodb/README.md | 16 ++++++++++++++-- centromere-sql/README.md | 14 ++++++++++++++ centromere-web/README.md | 12 ++++++++++++ 5 files changed, 79 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fbd378c..13e860c 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,33 @@ Database-specific implementations of the core repository interfaces and data imp The web module contains all components of the REST web services, including security and API documentation tools. ## Quick Start -Please see each individual module's README for instructions on getting started. +Please see each individual module's README for instructions on getting started. Artifacts for Centromere release builds are available from the Maven Central Repository: + +```xml + + org.oncoblocks.centromere + centromere-core + 0.3.0 + + + + org.oncoblocks.centromere + centromere-mongodb + 0.3.0 + + + + org.oncoblocks.centromere + centromere-sql + 0.3.0 + + + + org.oncoblocks.centromere + centromere-web + 0.3.0 + +``` ## Contact diff --git a/centromere-core/README.md b/centromere-core/README.md index 7150cdb..980bb6e 100644 --- a/centromere-core/README.md +++ b/centromere-core/README.md @@ -4,6 +4,18 @@ Components for creating database repositories for Centromere data warehouses. T ## Quick Start +### Maven + +You can get the latest release build of the Centromere Core module from Maven Central Repository: + +```xml + + org.oncoblocks.centromere + centromere-core + 0.3.0 + +``` + ### Creating a Data Model The first step in implementing a data warehouse with Centromere is to design a data model and create representational Java classes for each entity. Once implemented, a single model class will be used for each web service endpoint, so model classes should be considered to be atomic, normalized entities. All data model entity classes should implement the `Model` interface: diff --git a/centromere-mongodb/README.md b/centromere-mongodb/README.md index ed2e12e..abddd75 100644 --- a/centromere-mongodb/README.md +++ b/centromere-mongodb/README.md @@ -4,6 +4,18 @@ Repository class implementations for MongoDB. ## Quick Start +### Maven + +You can get the latest release build of the Centromere MongoDb module from Maven Central Repository: + +```xml + + org.oncoblocks.centromere + centromere-mongodb + 0.3.0 + +``` + ### Creating Repositories The `GenericMongoRepository` is the MongoDB implementation of `RepositoryOperations`, utilizing Spring Data MongoDB's `MongoTemplate` for query execution and object mapping. Before creating repository classes, you should configure your database connection: @@ -13,7 +25,7 @@ The `GenericMongoRepository` is the MongoDB implementation of `RepositoryOperati @Configuration @PropertySource({ "classpath:mongodb-data-source.properties" }) public class MongoConfig extends AbstractMongoConfiguration { - + @Autowired private Environment env; @Override @@ -33,7 +45,7 @@ public class MongoConfig extends AbstractMongoConfiguration { )); return new MongoClient(serverAddress, credentials); } - + } ``` diff --git a/centromere-sql/README.md b/centromere-sql/README.md index b4e0e42..51778b6 100644 --- a/centromere-sql/README.md +++ b/centromere-sql/README.md @@ -4,6 +4,20 @@ Repository implementations for SQL databases. ## Quick Start +### Maven + +You can get the latest release build of the Centromere SQL module from Maven Central Repository: + +```xml + + org.oncoblocks.centromere + centromere-sql + 0.3.0 + +``` + +### Creating Repositories + The `GenericJdbcRepository` is the JDBC SQL database implementation of `RepositoryOperations`. This repository implementation is based on `com.nurkiewicz.jdbcrepository.JdbcRepository`, but uses a more complex version of the `TableDescription` class, and a custom SQL generation class, `SqlBuilder`. Much like with `JdbcRepository`, you define a `GenericJdbcRepository` using a `ComplexTableDescription`, `RowMapper`, and optional `RowUnmapper`. For example: ```java diff --git a/centromere-web/README.md b/centromere-web/README.md index e7d92cf..484b0bd 100644 --- a/centromere-web/README.md +++ b/centromere-web/README.md @@ -4,6 +4,18 @@ Components for creating REST web services that sit on top of a Centromere data w ## Quick Start +### Maven + +You can get the latest release build of the Centromere Web module from Maven Central Repository: + +```xml + + org.oncoblocks.centromere + centromere-web + 0.3.0 + +``` + ### Configuration The easiest way to configure Centromere is to use the available auto-configuration annotations in a Spring Boot application class or supporting configuration class: `@AutoConfigureWebServices`, `@AutoConfigureWebSecurity`, and `@AutoConfigureApiDocumentation`. This will handle all of the required web context configuration and bean registration for the web services, API documentation, and security features: