svn commit: r1661576 - /gora/site/trunk/content/current/gora-shims.md

[le...@apache.org]

Author: lewismc
Date: Sun Feb 22 23:03:29 2015
New Revision: 1661576

URL: http://svn.apache.org/r1661576
Log:
Add Shims documentation template

Added:
    gora/site/trunk/content/current/gora-shims.md
      - copied, changed from r1660739, gora/site/trunk/content/current/gora-core.md

Copied: gora/site/trunk/content/current/gora-shims.md (from r1660739, gora/site/trunk/content/current/gora-core.md)
URL: http://svn.apache.org/viewvc/gora/site/trunk/content/current/gora-shims.md?p2=gora/site/trunk/content/current/gora-shims.md&p1=gora/site/trunk/content/current/gora-core.md&r1=1660739&r2=1661576&rev=1661576&view=diff
==============================================================================
--- gora/site/trunk/content/current/gora-core.md (original)
+++ gora/site/trunk/content/current/gora-shims.md Sun Feb 22 23:03:29 2015
@@ -1,124 +1,67 @@
 Title: Gora Core Module
 
 #Overview 
-This is the main documentation for DataStore's contained within the 
-<code>gora-core</code> module which (as it's name implies)
-holds most of the core functionality for the gora project. 
-
-Every module 
-in gora depends on gora-core therefore most of the generic documentation 
-about the project is gathered here as well as the documentation for <code>AvroStore</code>, 
-<code>DataFileAvroStore</code> and <code>MemStore</code>. In addition to this, gora-core holds all of the 
-core **MapReduce**, **Persistency**, **Query**, **DataStoreBase** and **Utility** functionality.
+This is the main documentation for Gora + Hadoop compatibility which comes in the
+form of <b>Gora Shims</b>. 
+
+According to our great friends over at [Wikipedia](http://en.wikipedia.org/wiki/Shim_%28computing%29),
+Shim's are described as
+
+    a small library that transparently intercepts API calls and changes the arguments passed, handles the operation itself, or redirects the operation elsewhere.[1][2] Shims typically come about when the behavior of an API changes, thereby causing compatibility issues for older applications which still rely on the older functionality. In such cases, the older API can still be supported by a thin compatibility layer on top of the newer code.
+
+Shims functionality in Gora is provided across the following Gora modules
+
+ * <b>gora-shims-distribution</b>, 
+ * <b>gora-shims-hadoop</b>,
+ * <b>gora-shims-hadoop1</b>, and 
+ * <b>gora-shims-hadoop2</b>
+
+As explained within the [Gora Core](./gora-core.html) module documentation,
+every module in Gora depends on [Gora Core](./gora-core.html). 
+In turn, [Gora Core](./gora-core.html) depends upon the 
+<b>gora-shims-distribution</b> module.
+
+This page therefore describes how to use the Gora Shims layers when building Gora
+into your software stack. 
 
 [TOC]
 
-#AvroStore
+#gora-shims-distribution
+
+##Description
+
+
+##Dependency
+
+
+##Direct Dependency
+
+#gora-shims-hadoop
 
 ##Description
-AvroStore can be used for binary-compatible Avro serializations. It supports Binary and JSON serializations.
 
-##gora.properties
 
-<table class="table">
-  <thead>
-   <tr>
-    <th align="left">Property Key</th>
-    <th align="left">Property Value</th> 
-    <th align="left">Required</th>
-    <th align="left">Description</th>
-   </tr>
-  </thead>
-  <tbody>
-   <tr>
-    <td>gora.datastore.default=</td>
-    <td>org.apache.gora.avro.store.AvroStore</td>
-    <td>Yes</td>
-    <td>Implementation of the persistent Java storage class</td>
-   </tr>
-   <tr>
-    <td>gora.avrostore.input.path=</td>
-    <td>*hdfs://uri/path/to/hdfs/input/path* || *file:///uri/path/to/local/input/path*</td>
-    <td>Yes</td>
-    <td>This value should point to the input directory on hdfs (if running Gora in a distributed Hadoop environment) or to some location input directory on the local file system (if running Gora locally).</td>
-   </tr>
-   <tr>
-    <td>gora.avrostore.output.path=</td>
-    <td>*hdfs://uri/path/to/hdfs/output/path* || *file:///uri/path/to/local/output/path*</td>
-    <td>Yes</td>
-    <td>This value should point to the output directory on hdfs (if running Gora in a distributed Hadoop environment) or to some location output location on the local file system (if running Gora locally).</td>
-   </tr>
-   <tr>
-    <td>gora.avrostore.codec.type=</td>
-    <td>BINARY || JSON</td>
-    <td>No</td>
-    <td>The property key specifying avro encoder/decoder type to use. Can take values <code>BINARY</code> or <code>JSON</code> but resolves to BINARY is one is not supplied.</td>
-   </tr>
-  </tboday>
-</table>
+##Dependency
+
 
-##AvroStore XML mappings
-In the stores covered within the gora-core module, no physical mappings are required.
+##Direct Dependency
 
-#DataFileAvroStore
+#gora-shims-hadoop1
 
 ##Description
-DataFileAvroStore is file based store which extends <codeAvroStore</code> to use Avro's <code>DataFile{Writer,Reader}</code>'s as a backend. 
-This datastore supports MapReduce.
 
-##gora.properties
-DataFileAvroStore would be configured exactly the same as in AvroStore above with the following exception
-<table class="table">
-  <thead>
-   <tr>
-    <th align="left">Property Key</th>
-    <th align="left">Property Value</th> 
-    <th align="left">Required</th>
-    <th align="left">Description</th>
-   </tr>
-  </thead>
-  <tbody>
-   <tr>
-    <td>gora.datastore.default=</td>
-    <td>org.apache.gora.avro.store.DataFileAvroStore</td>
-    <td>Yes</td>
-    <td>Implementation of the persistent Java storage class</td>
-   </tr>
-  </tboday>
-</table>
 
-##Gora Core mappings
-In the stores covered within the gora-core module, no physical mappings are required.
+##Dependency
 
-#MemStore
+
+##Direct Dependency
+
+#gora-shims-hadoop2
 
 ##Description
-Essentially this store is a ConcurrentSkipListMap in which operations run as follows
- * put(K key, T Object) - expect average log(n)
- * get(K key, String [] fields) - expect average log(n)
- * delete(K key) - expect average log(n)
-
-##gora.properties
-MemStore would be configured exactly the same as in AvroStore above with the following exception
-<table class="table">
-  <thead>
-   <tr>
-    <th align="left">Property Key</th>
-    <th align="left">Property Value</th> 
-    <th align="left">Required</th>
-    <th align="left">Description</th>
-   </tr>
-  </thead>
-  <tbody>
-   <tr>
-    <td>gora.datastore.default=</td>
-    <td>org.apache.gora.memory.store.MemStore</td>
-    <td>Yes</td>
-    <td>Implementation of the Java class used to hold data in memory</td>
-   </tr>
-  </tboday>
-</table>
 
-##MemStore XML mappings
-In the stores covered within the gora-core module, no physical mappings are required.
 
+##Dependency
+
+
+##Direct Dependency