gora-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r865881 - in /websites/staging/gora/trunk/content: ./ current/compiler.html
Date Sun, 16 Jun 2013 23:23:28 GMT
Author: buildbot
Date: Sun Jun 16 23:23:28 2013
New Revision: 865881

Log:
Staging update by buildbot for gora

Added:
    websites/staging/gora/trunk/content/current/compiler.html
Modified:
    websites/staging/gora/trunk/content/   (props changed)

Propchange: websites/staging/gora/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Sun Jun 16 23:23:28 2013
@@ -1 +1 @@
-1493262
+1493613

Added: websites/staging/gora/trunk/content/current/compiler.html
==============================================================================
--- websites/staging/gora/trunk/content/current/compiler.html (added)
+++ websites/staging/gora/trunk/content/current/compiler.html Sun Jun 16 23:23:28 2013
@@ -0,0 +1,198 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- 
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License. 
+-->
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <meta name="author" content="dev@gora.apache.org" />
+
+  <META http-equiv="Content-Type" content="text/html;charset=UTF-8" />
+  <META name="Description" content="Apache Gora -- Gora Compiler Overview" />
+  <META name="Keywords" content="Apache Gora NoSQL Framework" />
+  <META name="Owner" content="dev@gora.apache.org" />
+  <META name="Robots" content="index, follow" />
+  <META name="Security" content="Public" />
+  <META name="Source" content="wiki template" />
+  <META name="DC.Rights" content="Copyright � 2010-2013, The Apache Software Foundation"
/>
+
+  <!-- The styles -->
+  <link href="./../resources/css/bootstrap.css" rel="stylesheet">
+  <style type="text/css">
+    body {
+      padding-top: 60px;
+      padding-bottom: 40px;
+    }
+  </style>
+  <link href="./../resources/css/bootstrap-responsive.css" rel="stylesheet">
+  <link href="./../resources/css/gora.css" rel="stylesheet">
+
+  <!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
+  <!--[if lt IE 9]>
+    <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+
+  <!-- Fav and touch icons -->
+  <link rel="apple-touch-icon-precomposed" sizes="144x144" href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-144-precomposed.png">
+  <link rel="apple-touch-icon-precomposed" sizes="114x114" href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-114-precomposed.png">
+  <link rel="apple-touch-icon-precomposed" sizes="72x72" href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-72-precomposed.png">
+  <link rel="apple-touch-icon-precomposed" href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-57-precomposed.png">
+  <link rel="shortcut icon" href="./../resources/img/feather-small.png">
+
+  <title>Apache Gora&trade;</title>
+</head>
+
+<body>
+  <div class="navbar navbar-inverse navbar-fixed-top">
+    <div class="navbar-inner">
+      <div class="container">
+        <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+        </a>
+        <a class="brand" href="./../index.html"><img src="./../resources/img/gora-logo.png"
alt="Apache Gora" title="Apache Gora" style="width: 50%; height: 50%;"/></a>
+        <div class="nav-collapse collapse">
+          <ul class="nav">
+            <li><a href="./../downloads.html">Downloads</a></li>
+            <li class="dropdown">
+              <a href="#" class="dropdown-toggle" data-toggle="dropdown">Community
<b class="caret"></b></a>
+              <ul class="dropdown-menu pull-right">
+                <li><a href="./../board-reports/index.html">Board Reporting</a></li>
+                <li><a href="./../contribute.html">Contribute</a></li>
+                <li><a href="./../mailing_lists.html">Mailing Lists</a></li>
+                <li><a href="./../credits.html">People</a></li>
+                <li><a href="./../related.html">Related Projects</a></li>
+              </ul>
+            </li>
+            <li class="dropdown">
+              <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation
<b class="caret"></b></a>
+              <ul class="dropdown-menu pull-right">
+                <li><a href="./../about.html">About</a></li>
+                <li><a href="./../current/overview.html">Current Documentation</a></li>
+                <li><a href="./../current/api/javadoc.html">JavaDoc Documentation</a></li>
+                <li><a href="./../current/tutorial.html">Gora Tutorial</a></li>
+              </ul>
+            </li>
+            <li class="dropdown">
+              <a href="#" class="dropdown-toggle" data-toggle="dropdown">Development
<b class="caret"></b></a>
+              <ul class="dropdown-menu pull-right">
+                <li><a href="./../issue_tracking.html">Issue Tracking</a></li>
+                <li><a href="./../mailing_lists.html">Mailing Lists</a></li>
+                <li><a href="./../nightly_builds.html">Nightly Builds</a></li>
+                <li><a href="./../version_control.html">Version Control</a></li>
+              </ul>
+            </li>
+            <li class="dropdown">
+              <a href="#" class="dropdown-toggle" data-toggle="dropdown">
+                <img src="./../resources/img/feather-small.png" alt="Apache" title="Apache"
/> <b class="caret"></b></a>
+              <ul class="dropdown-menu pull-right">
+                <li><a href="http://www.apache.org">Apache Home</a></li>
+                <li><a href="http://www.apache.org/licenses/">Apache License</a></li>
+                <li><a href="http://www.apache.org/security/">Security</a></li>
+                <li><a href="http://www.apache.org/foundation/sponsorship.html">Support</a></li>
+                <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+              </ul>
+            </li>
+          </ul>
+          <form id="search-form" class="navbar-search pull-right" action="http://www.google.com/cse"
method="get">
+            <input value="gora.apache.org" name="sitesearch" type="hidden" />
+            <input class="search-query" name="q" id="query" type="text" />
+          </form>
+          <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script>
+        </div> <!--/.nav-collapse -->
+      </div> <!-- /container -->
+    </div> <!-- /navbar-inner -->
+  </div> <!-- /navbar -->
+  
+  <div class="container" id="Gora_Gora Compiler Overview">
+
+<h1 id="introduction">Introduction</h1>
+<p>The Gora compiler converts JSON files (the schema(s)) into persistent Java classes/data
beans. 
+You can then use those classes to interact with a variety of data storage software e.g. the
Gora datastore implementations. </p>
+<p>The compiler is very simple to run. But first you should add the Gora installation
directory to your path. </p>
+<h1 id="usage">Usage</h1>
+<div class="codehilite"><pre> $ <span class="n">bin</span><span
class="o">/</span><span class="n">gora</span> <span class="n">goracompiler</span>
+</pre></div>
+
+
+<p>results in:</p>
+<div class="codehilite"><pre> $ <span class="n">Usage</span><span
class="p">:</span> <span class="n">GoraCompiler</span> <span class="o">&lt;</span><span
class="n">schema</span> <span class="n">file</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">output</span> <span
class="n">dir</span><span class="o">&gt;</span> <span class="p">[</span><span
class="o">-</span><span class="n">license</span> <span class="o">&lt;</span><span
class="n">id</span><span class="o">&gt;</span><span class="p">]</span>
+   <span class="o">&lt;</span><span class="n">schema</span> <span
class="n">file</span><span class="o">&gt;</span>     <span class="o">-</span>
<span class="n">individual</span> <span class="n">avsc</span> <span
class="n">file</span> <span class="n">to</span> <span class="n">be</span>
<span class="n">compiled</span> <span class="n">or</span> <span
class="n">a</span> <span class="n">directory</span> <span class="n">path</span>
<span class="n">containing</span> <span class="n">avsc</span> <span
class="n">files</span>
+   <span class="o">&lt;</span><span class="n">output</span> <span
class="n">dir</span><span class="o">&gt;</span>      <span class="o">-</span>
<span class="n">output</span> <span class="n">directory</span> <span
class="k">for</span> <span class="n">generated</span> <span class="n">Java</span>
<span class="n">files</span>
+   <span class="p">[</span><span class="o">-</span><span class="n">license</span>
<span class="o">&lt;</span><span class="n">id</span><span class="o">&gt;</span><span
class="p">]</span>   <span class="o">-</span> <span class="n">the</span>
<span class="n">preferred</span> <span class="n">license</span> <span
class="n">header</span> <span class="n">to</span> <span class="n">add</span>
<span class="n">to</span> <span class="n">the</span>
+           <span class="n">generated</span> <span class="n">Java</span>
<span class="n">file</span><span class="p">.</span> <span class="n">Current</span>
<span class="n">options</span> <span class="n">include</span><span
class="p">;</span> 
+    <span class="n">ASLv2</span>   <span class="p">(</span><span
class="n">Apache</span> <span class="n">Software</span> <span class="n">License</span>
<span class="n">v2</span><span class="p">.</span>0<span class="p">)</span>

+    <span class="n">AGPLv3</span>  <span class="p">(</span><span
class="n">GNU</span> <span class="n">Affero</span> <span class="n">General</span>
<span class="n">Public</span> <span class="n">License</span><span
class="p">)</span>
+    <span class="n">CDDLv1</span>  <span class="p">(</span><span
class="n">Common</span> <span class="n">Development</span> <span class="n">and</span>
<span class="n">Distribution</span> <span class="n">License</span>
<span class="n">v1</span><span class="p">.</span>0<span class="p">)</span>
+    <span class="n">FDLv13</span>  <span class="p">(</span><span
class="n">GNU</span> <span class="n">Free</span> <span class="n">Documentation</span>
<span class="n">License</span> <span class="n">v1</span><span class="p">.</span>3<span
class="p">)</span>
+    <span class="n">GPLv1</span>   <span class="p">(</span><span
class="n">GNU</span> <span class="n">General</span> <span class="n">Public</span>
<span class="n">License</span> <span class="n">v1</span><span class="p">.</span>0<span
class="p">)</span>
+    <span class="n">GPLv2</span>   <span class="p">(</span><span
class="n">GNU</span> <span class="n">General</span> <span class="n">Public</span>
<span class="n">License</span> <span class="n">v2</span><span class="p">.</span>0<span
class="p">)</span>
+    <span class="n">GPLv3</span>   <span class="p">(</span><span
class="n">GNU</span> <span class="n">General</span> <span class="n">Public</span>
<span class="n">License</span> <span class="n">v3</span><span class="p">.</span>0<span
class="p">)</span>
+    <span class="n">LGPLv21</span> <span class="p">(</span><span
class="n">GNU</span> <span class="n">Lesser</span> <span class="n">General</span>
<span class="n">Public</span> <span class="n">License</span> <span
class="n">v2</span><span class="p">.</span>1<span class="p">)</span>
+    <span class="n">LGPLv3</span>  <span class="p">(</span><span
class="n">GNU</span> <span class="n">Lesser</span> <span class="n">General</span>
<span class="n">Public</span> <span class="n">License</span> <span
class="n">v2</span><span class="p">.</span>1<span class="p">)</span>
+</pre></div>
+
+
+<p>so for example, one would typically enter:</p>
+<div class="codehilite"><pre> $ <span class="n">bin</span><span
class="o">/</span><span class="n">gora</span> <span class="n">goracompiler</span>
<span class="n">gora</span><span class="o">-</span><span class="n">tutorial</span><span
class="o">/</span><span class="n">src</span><span class="o">/</span><span
class="n">main</span><span class="o">/</span><span class="n">avro</span><span
class="o">/</span><span class="n">pageview</span><span class="p">.</span><span
class="n">json</span> <span class="n">gora</span><span class="o">-</span><span
class="n">tutorial</span><span class="o">/</span><span class="n">src</span><span
class="o">/</span><span class="n">main</span><span class="o">/</span><span
class="n">java</span><span class="o">/</span>
+</pre></div>
+
+
+<p>The schema file is a single JSON file or a directory containing JSON files. </p>
+<p>The output directory is the destination for the generated Java source files. For
example, if you specific src/main/java then the 
+generate source is placed into src/main/java/generated. It's generally a good idea to ignore
the generate directory in whatever 
+version control software you're using. You are using version control, right?</p>
+<p>Finally, the license parameter tells the compile to add a license header to each
generated file. Current header options include:</p>
+<ul>
+<li>ASLv2   (<a href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache
Software License v2.0</a>)</li>
+<li>AGPLv3  (<a href="http://www.gnu.org/licenses/agpl.html">GNU Affero General
Public License</a>)</li>
+<li>CDDLv1  (<a href="http://opensource.org/licenses/CDDL-1.0">Common Development
and Distribution License v1.0</a>)</li>
+<li>FDLv13  (<a href-"http://www.gnu.org/copyleft/fdl.html">GNU Free Documentation
License v1.3</a>)</li>
+<li>GPLv1   (<a href="http://www.gnu.org/licenses/gpl-1.0.html">GNU General Public
License v1.0</a>)</li>
+<li>GPLv2   (<a href="http://www.gnu.org/licenses/gpl-2.0.html">GNU General Public
License v2.0</a>)</li>
+<li>GPLv3   (<a href="http://www.gnu.org/licenses/gpl-3.0.html">GNU General Public
License v3.0</a>)</li>
+<li>LGPLv21 (<a href="http://www.gnu.org/licenses/lgpl-2.1.html">GNU Lesser General
Public License v2.1</a>)</li>
+<li>LGPLv3  (<a href="http://www.gnu.org/licenses/lgpl-3.0.html">GNU Lesser General
Public License v3</a>)</li>
+</ul>
+<p>It should be noted that if no license header argument is passed, by default the
ASLv2 license profile is selected.</p>
+
+  </div> <!-- /container (main block) -->
+
+  <hr>
+
+  <div class="container">
+    <footer>
+      <p>Copyright © 2010-2013 The Apache Software Foundation. Licensed under <a
href="http://www.apache.org/licenses/LICENSE-2.0">Apache License 2.0</a>.
+      </p>
+      <p>Apache Gora, Gora, Apache, the Apache feather logo, and the Apache Gora project
logo are trademarks of The Apache Software Foundation.
+      </p>
+    </footer>
+
+  </div> <!-- /container -->
+
+  <!-- The javascript
+  ================================================== -->
+  <!-- Placed at the end of the document so the pages load faster -->
+  <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.1/jquery.min.js"; type="text/javascript"></script>
+  <script src="/resources/js/bootstrap.min.js"></script>
+
+</body>
+</html>



Mime
View raw message