You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@marmotta.apache.org by bu...@apache.org on 2013/02/28 14:38:24 UTC

svn commit: r852402 [7/7] - in /websites/staging/marmotta/trunk/content: ./ apidocs/ apidocs/org/apache/marmotta/kiwi/caching/ apidocs/org/apache/marmotta/kiwi/caching/class-use/ apidocs/org/apache/marmotta/kiwi/config/ apidocs/org/apache/marmotta/kiwi...

Modified: websites/staging/marmotta/trunk/content/ldcache/usage.html
==============================================================================
--- websites/staging/marmotta/trunk/content/ldcache/usage.html (original)
+++ websites/staging/marmotta/trunk/content/ldcache/usage.html Thu Feb 28 13:38:18 2013
@@ -316,7 +316,34 @@
                 
         <div id="bodyColumn" >
                                   
-            <h1>LDCache Usage</h1><p>@TODO@</p>
+            <h1>LDCache Usage</h1><p>Currently, all libraries of the Linked Data Cache are available only via Maven or as part of the Marmotta source code.</p><div class="section"><h2>Maven Artifacts<a name="Maven_Artifacts"></a></h2><p>To use the Linked Data Cache in your own projects, please add the following Maven dependencies to your project build:</p>
+<div class="source"><pre class="prettyprint">&lt;dependency&gt;
+    &lt;groupId&gt;org.apache.marmotta&lt;/groupId&gt;
+    &lt;artifactId&gt;ldcache-api&lt;/artifactId&gt;
+    &lt;version&gt;3.0.0-incubating-SNAPSHOT&lt;/version&gt;
+&lt;/dependency&gt;
+&lt;dependency&gt;
+    &lt;groupId&gt;org.apache.marmotta&lt;/groupId&gt;
+    &lt;artifactId&gt;ldcache-core&lt;/artifactId&gt;
+    &lt;version&gt;3.0.0-incubating-SNAPSHOT&lt;/version&gt;
+&lt;/dependency&gt;
+</pre></div><p>In order to use the Linked Data Cache, youll also need to add at least one caching backend to the project. Assuming you are using the KiWi triple store, you would add the KiWi caching backend as follows:</p>
+<div class="source"><pre class="prettyprint">&lt;dependency&gt;
+    &lt;groupId&gt;org.apache.marmotta&lt;/groupId&gt;
+    &lt;artifactId&gt;ldcache-backend-kiwi&lt;/artifactId&gt;
+    &lt;version&gt;3.0.0-incubating-SNAPSHOT&lt;/version&gt;
+&lt;/dependency&gt;
+</pre></div><p>A number of additional caching backends are currently under development. We are at least planning to release the two following backends:</p>
+<ul>
+  <li><tt>ldcache-backend-ehcache</tt> will store caching information in a EHCache in-memory cache; cache information will get lost  on restart</li>
+  <li><tt>ldcache-backend-mapdb</tt> will store caching information in a persistent hash map; cache information will survive a  restart, but this implementation will be less scalable</li>
+</ul><p>In case you also want to use the transparent Linked Data cache in your respository, you also need to include one of the connection wrappers in your project. If you are using the KiWi triple store, add the following additional artifact:</p>
+<div class="source"><pre class="prettyprint">&lt;dependency&gt;
+    &lt;groupId&gt;org.apache.marmotta&lt;/groupId&gt;
+    &lt;artifactId&gt;ldcache-sail-kiwi&lt;/artifactId&gt;
+    &lt;version&gt;3.0.0-incubating-SNAPSHOT&lt;/version&gt;
+&lt;/dependency&gt;
+</pre></div></div><div class="section"><h2>Retrieving Cache Entries<a name="Retrieving_Cache_Entries"></a></h2></div><div class="section"><h2>Transparent Linked Data Access<a name="Transparent_Linked_Data_Access"></a></h2></div>
                   </div>
           </div>