Bug 516176 - add documentation to the README
Change-Id: I82edfbef028fb23c80ca5d40a308c2899286e8d8
Signed-off-by: Andrii Berezovskyi <andriib@kth.se>
diff --git a/org.eclipse.lyo.tools.store/doc/architecture.png b/org.eclipse.lyo.tools.store/doc/lyo_store-architecture.png
similarity index 100%
rename from org.eclipse.lyo.tools.store/doc/architecture.png
rename to org.eclipse.lyo.tools.store/doc/lyo_store-architecture.png
Binary files differ
diff --git a/org.eclipse.lyo.tools.store/doc/store.md b/org.eclipse.lyo.tools.store/doc/store.md
index 4ebb6ac..78a125d 100644
--- a/org.eclipse.lyo.tools.store/doc/store.md
+++ b/org.eclipse.lyo.tools.store/doc/store.md
@@ -25,7 +25,7 @@
services of the OSLC Server component. From such a model, the classes and
services can be generated.
-
+
## Getting started
@@ -43,6 +43,20 @@
</dependency>
```
+**NOTE!** If you are using the older versions of Lyo (2.1.2 and lower), Maven might decide to use an incompatible version of Jena. In order to prevent this, enforce the Jena version used by `lyo-store` by adding the following tag to the `pom.xml`:
+
+```xml
+<dependencyManagement>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.jena</groupId>
+ <artifactId>jena-core</artifactId>
+ <version>2.13.0</version>
+ </dependency>
+ </dependencies>
+</dependencyManagement>
+```
+
Now you are all set to start using the library. If you encounter any API
questions along the way, consult the [Javadoc][javadoc] or ask a question on the
[Lyo forum][forum].
diff --git a/org.eclipse.lyo.tools.store/doc/store.wiki b/org.eclipse.lyo.tools.store/doc/store.wiki
index f93a115..1c56e33 100644
--- a/org.eclipse.lyo.tools.store/doc/store.wiki
+++ b/org.eclipse.lyo.tools.store/doc/store.wiki
@@ -1,6 +1,6 @@
= Lyo Store =
-''Lyo Store'' is a library that provides a simple interface for working with a *triplestore via Java objects representing OSLC Resources.
+''Lyo Store'' is a library that provides a simple interface for working with a triplestore via Java objects representing OSLC Resources.
== Introduction ==
@@ -10,11 +10,11 @@
So naturally, all components of this architecture need to share the common set of OSLC4J-annotated classes. To facilitate this effort, the adaptor developer can take advantage of the [https://wiki.eclipse.org/Lyo/ToolchainModellingAndCodeGenerationWorkshop OSLC Lyo Modelling tool] in order to graphically model the business objects to be exposed, as well as the services of the OSLC Server component. From such a model, the classes and services can be generated.
-[[File:architecture.png|frame|none]]
+[[File:lyo_store-architecture.png|center|800px]]
== Getting started ==
-Lyo uses Maven as a primary choice for the build system. Make sure your POM file includes Eclipse Maven repositories (see [https://wiki.eclipse.org/Lyo/LyoOSLC4J#Using_in_Maven OSLC4J instructions] wiki page).
+Lyo uses Maven as a primary choice for the build system. Make sure your POM file includes Eclipse Maven repositories (see the [https://wiki.eclipse.org/Lyo/LyoOSLC4J#Using_in_Maven OSLC4J instructions]).
Add the following dependency:
@@ -23,6 +23,20 @@
<artifactId>lyo-store</artifactId>
<version>2.2.0-SNAPSHOT</version>
</dependency></source>
+<p></p>
+'''NOTE!''' If you are using the older versions of Lyo (2.1.2 and lower), Maven might decide to use an incompatible version of Jena. In order to prevent this, enforce the Jena version used by <code>lyo-store</code> by adding the following tag to the <code>pom.xml</code>:
+
+<source lang="xml"><dependencyManagement>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.jena</groupId>
+ <artifactId>jena-core</artifactId>
+ <version>2.13.0</version>
+ </dependency>
+ </dependencies>
+</dependencyManagement></source>
+<p></p>
+
Now you are all set to start using the library. If you encounter any API questions along the way, consult the [http://assume.gitlab.io/jena-cache/apidocs/overview-summary.html Javadoc] or ask a question on the [https://www.eclipse.org/forums/index.php/f/228/ Lyo forum].
== Using Lyo Store ==
@@ -35,6 +49,8 @@
} catch (StoreAccessException e) {
logger.error("Error executing a query on a triplestore");
}</source>
+<p></p>
+
In order to retrieve the resources of type <code>Requirement</code> from the triplestore in batches of 200:
<source lang="java">if (store.namedGraphExists(GRAPH_NAME)) {
@@ -53,10 +69,13 @@
logger.error("Error unmarshalling the RDF from triplestore into Requirement class instances");
}
}</source>
+<p></p>
+
+See [http://assume.gitlab.io/jena-cache/apidocs/org/eclipse/lyo/tools/store/Store.html Store javadoc] for all available methods.
+
== Links ==
* '''[http://assume.gitlab.io/jena-cache/apidocs/overview-summary.html Lyo Store Javadoc]'''
* [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Lyo&component=Tools File a new Lyo Tools bug]
* [https://www.eclipse.org/forums/index.php/f/228/ Ask a question on Eclipse Lyo forum]
* '''[https://wiki.eclipse.org/Lyo#Contributing_to_Lyo Contribute to Eclipse Lyo!]'''
-
