sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r1019181 - in /websites/staging/sis/trunk/content: ./ downloads.html epsg.html
Date Fri, 06 Oct 2017 12:53:06 GMT
Author: buildbot
Date: Fri Oct  6 12:53:06 2017
New Revision: 1019181

Log:
Staging update by buildbot for sis

Modified:
    websites/staging/sis/trunk/content/   (props changed)
    websites/staging/sis/trunk/content/downloads.html
    websites/staging/sis/trunk/content/epsg.html

Propchange: websites/staging/sis/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Oct  6 12:53:06 2017
@@ -1 +1 @@
-1809817
+1811325

Modified: websites/staging/sis/trunk/content/downloads.html
==============================================================================
--- websites/staging/sis/trunk/content/downloads.html (original)
+++ websites/staging/sis/trunk/content/downloads.html Fri Oct  6 12:53:06 2017
@@ -171,25 +171,17 @@ If you accept those terms of use, then t
 <div class="codehilite"><pre><span class="nt">&lt;dependencies&gt;</span>
   <span class="nt">&lt;dependency&gt;</span>
     <span class="nt">&lt;groupId&gt;</span>org.apache.sis.non-free<span
class="nt">&lt;/groupId&gt;</span>
-    <span class="nt">&lt;artifactId&gt;</span>sis-epsg<span class="nt">&lt;/artifactId&gt;</span>
+    <span class="nt">&lt;artifactId&gt;</span>sis-embedded-data<span
class="nt">&lt;/artifactId&gt;</span>
     <span class="nt">&lt;version&gt;</span>${sis.version}<span class="nt">&lt;/version&gt;</span>
     <span class="nt">&lt;scope&gt;</span>runtime<span class="nt">&lt;/scope&gt;</span>
   <span class="nt">&lt;/dependency&gt;</span>
-
-  <span class="c">&lt;!-- Following dependency can be omitted on Oracle JDK6, JDK7
or JDK8</span>
-<span class="c">       since those Java distributions contain Derby (a.k.a JavaDB).
--&gt;</span>
-  <span class="nt">&lt;dependency&gt;</span>
-    <span class="nt">&lt;groupId&gt;</span>org.apache.derby<span class="nt">&lt;/groupId&gt;</span>
-    <span class="nt">&lt;artifactId&gt;</span>derby<span class="nt">&lt;/artifactId&gt;</span>
-    <span class="nt">&lt;version&gt;</span>10.12.1.1<span class="nt">&lt;/version&gt;</span>
-    <span class="nt">&lt;scope&gt;</span>runtime<span class="nt">&lt;/scope&gt;</span>
-  <span class="nt">&lt;/dependency&gt;</span>
 <span class="nt">&lt;/dependencies&gt;</span>
 </pre></div>
 
 
-<p>In addition, user should set the <code>SIS_DATA</code> environment variable
to an initially empty directory
-where Apache SIS will store the EPSG geodetic database.
+<p>Above dependency uses a read-only embedded Derby database.
+But it is also possible to use an EPSG database on HSQL or PostgreSQL,
+or a database allowing additions of user definitions.
 See <a href="epsg.html">How to use EPSG geodetic dataset</a> page for more information.</p>
             </article>
           </section>

Modified: websites/staging/sis/trunk/content/epsg.html
==============================================================================
--- websites/staging/sis/trunk/content/epsg.html (original)
+++ websites/staging/sis/trunk/content/epsg.html Fri Oct  6 12:53:06 2017
@@ -119,7 +119,11 @@ are incompatible with Apache license. Th
 <div class="toc">
 <ul>
 <li><a href="#command-line">Install a local copy with command-line tool</a></li>
-<li><a href="#maven">Add a Maven dependency</a></li>
+<li><a href="#maven">Add a Maven dependency</a><ul>
+<li><a href="#maven-epsg">As database installer</a></li>
+<li><a href="#maven-embedded">As embedded database</a></li>
+</ul>
+</li>
 <li><a href="#jndi">Use Java Naming and Directory Interface</a><ul>
 <li><a href="#jndi-java">Registration by Java code</a></li>
 <li><a href="#jndi-webapp">Registration in web application containers</a></li>
@@ -136,41 +140,94 @@ For example:</p>
 
 <p>The first time that the command-line tool needs to query EPSG, it will prompt the
user for authorization
 to download EPSG geodetic dataset from Maven Central. If the user accepts EPSG terms of use,
then a local
-copy of the EPSG geodetic dataset will be created and stored in the <code>apache-sis-0.7/data</code>
sub-directory.</p>
+copy of the EPSG geodetic dataset will be created and stored in the <code>apache-sis-0.8/data</code>
sub-directory.</p>
 <p>If the command-line tool does not offer to download the EPSG geodetic dataset,
-try adding a <code>derby-&lt;version&gt;.jar</code> file (download lib-distribution
from <a href="http://db.apache.org/derby/derby_downloads.html">Derby project</a>)
in the <code>apache-sis-0.7/lib</code> sub-directory.
+try adding a <code>derby-&lt;version&gt;.jar</code> file (download lib-distribution
from <a href="http://db.apache.org/derby/derby_downloads.html">Derby project</a>)
in the <code>apache-sis-0.8/lib</code> sub-directory.
 This is normally not needed with Oracle JDK6, JDK7 or JDK8 because Apache SIS tries to use
the JavaDB embedded
 in those distributions, but may be necessary with other distributions or in security-constrained
environments.</p>
 <p>For using the installed EPSG geodetic dataset in your own application, apply <em>one</em>
of the following choices:</p>
 <ul>
-<li>Set the <code>SIS_DATA</code> environment variable to the path to the
<code>apache-sis-0.7/data</code> directory <em>(preferred choice)</em>.</li>
-<li>Set the <code>derby.system.home</code> Java property to the path to
the <code>apache-sis-0.7/data/Databases</code> directory.</li>
+<li>Set the <code>SIS_DATA</code> environment variable to the path of <code>apache-sis-0.8/data</code>
directory <em>(preferred choice)</em>.</li>
+<li>Set the <code>derby.system.home</code> Java property to the path of
<code>apache-sis-0.8/data/Databases</code> directory.</li>
 </ul>
-<p>Alternatively <code>SIS_DATA</code> or <code>derby.system.home</code>
can be set to the path of any other directory which contain the same files.</p>
+<p>Alternatively <code>SIS_DATA</code> or <code>derby.system.home</code>
can be set to the path of any other directory which contain the same files.
+Examples are shown below for Unix systems, assuming that the current directory is the directory
where <code>apache-sis-0.8-bin.zip</code>
+has been unzipped:</p>
+<div class="codehilite"><pre><span class="nb">export </span><span
class="nv">SIS_DATA</span><span class="o">=</span>apache-sis-0.8/data
+java -classpath apache-sis-0.8/lib/sis.jar:myApp.jar myMainClass
+</pre></div>
+
+
+<p>If the <code>SIS_DATA</code> environment variable can not be set, Java
property can be used as a fallback:</p>
+<div class="codehilite"><pre><span class="n">java</span> <span
class="o">-</span><span class="n">Dderby</span><span class="p">.</span><span
class="n">system</span><span class="p">.</span><span class="n">home</span><span
class="p">=</span><span class="n">apache</span><span class="o">-</span><span
class="n">sis</span><span class="o">-</span>0<span class="p">.</span>8<span
class="o">/</span><span class="n">data</span><span class="o">/</span><span
class="n">Databases</span> <span class="o">-</span><span class="n">classpath</span>
<span class="n">apache</span><span class="o">-</span><span class="n">sis</span><span
class="o">-</span>0<span class="p">.</span>8<span class="o">/</span><span
class="n">lib</span><span class="o">/</span><span class="n">sis</span><span
class="p">.</span><span class="n">jar</span><span class="p">:</span><span
class="n">myApp</span><span class="p">.</span><span class="n">jar</span>
<span class="n">myMainClass</span>
+</pre></div>
+
+
 <h1 id="maven">Add a Maven dependency<a class="headerlink" href="#maven" title="Permanent
link">&para;</a></h1>
 <p>Maven projects can get the EPSG geodetic dataset automatically, <em>without
any prompt for terms of use agreement</em>,
-if they add a dependency to the
-<code style="white-space:normal">org.apache.sis.non-free:​sis-epsg:​0.7</code>
-artifact in their project.
-We assume that developers who add this dependency explicitely in their project agree with
EPSG terms of use.
-The <code>&lt;dependency&gt;</code> fragment to use in <code>pom.xml</code>
files is given in the <a href="downloads.html#epsg">download</a> page.</p>
-<p>In addition, users need to apply <em>one</em> of the following choices:</p>
+if they add a <code>sis-epsg</code> or <code>sis-embedded-data</code>
dependency (from <code>org.apache.sis.non-free</code> group) in their project.
+Those two approaches have advantages and inconvenient described in following sub-sections.
+In both cases, we assume that developers who add those dependencies explicitely in their
project agree with
+<a href="http://www.epsg.org/TermsOfUse">EPSG terms of use</a>.</p>
+<h2 id="maven-epsg">As database installer<a class="headerlink" href="#maven-epsg"
title="Permanent link">&para;</a></h2>
+<p>With <code>sis-epsg</code> artifact on the classpath, Apache SIS will
create a local copy of EPSG database when first needed.
+The target database must be specified by users with <em>one</em> of the following
choices:</p>
 <ul>
-<li>Set the <code>SIS_DATA</code> environment variable to the path of an
initially empty directory <em>(preferred choice)</em>.</li>
+<li>Set the <code>SIS_DATA</code> environment variable to the path of an
initially empty directory <em>(preferred choice)</em>.
+    The specified directory must exist, but sub-directories will be created as needed.</li>
 <li>Set the <code>derby.system.home</code> Java property to the path of
an initially empty directory,
-    or a directory that contain other Derby databases.</li>
+    or a directory that contain other Derby databases. The specified directory must exist.</li>
 <li>Register a <code>DataSource</code> under the <code>java:comp/env/jdbc/SpatialMetadata</code>
name in a JNDI directory
     (see <a href="#jndi">next section</a>). The database must exist but can be
initially empty.</li>
 </ul>
-<p>The directory referenced by <code>SIS_DATA</code> or <code>derby.system.home</code>
must exist.
-Sub-directories in that directory will be created as needed.</p>
+<p>The Maven dependency is as below (the Derby dependency can be replaced by another
database driver
+if that database is specified by JNDI):</p>
+<div class="codehilite"><pre><span class="nt">&lt;dependencies&gt;</span>
+  <span class="nt">&lt;dependency&gt;</span>
+    <span class="nt">&lt;groupId&gt;</span>org.apache.sis.non-free<span
class="nt">&lt;/groupId&gt;</span>
+    <span class="nt">&lt;artifactId&gt;</span>sis-epsg<span class="nt">&lt;/artifactId&gt;</span>
+    <span class="nt">&lt;version&gt;</span>${sis.version}<span class="nt">&lt;/version&gt;</span>
+    <span class="nt">&lt;scope&gt;</span>runtime<span class="nt">&lt;/scope&gt;</span>
+  <span class="nt">&lt;/dependency&gt;</span>
+
+  <span class="c">&lt;!-- Following dependency can be omitted on Oracle JDK6, JDK7
or JDK8</span>
+<span class="c">       since those Java distributions contain Derby (a.k.a JavaDB).
--&gt;</span>
+  <span class="nt">&lt;dependency&gt;</span>
+    <span class="nt">&lt;groupId&gt;</span>org.apache.derby<span class="nt">&lt;/groupId&gt;</span>
+    <span class="nt">&lt;artifactId&gt;</span>derby<span class="nt">&lt;/artifactId&gt;</span>
+    <span class="nt">&lt;version&gt;</span>10.13.1.1<span class="nt">&lt;/version&gt;</span>
+    <span class="nt">&lt;scope&gt;</span>runtime<span class="nt">&lt;/scope&gt;</span>
+  <span class="nt">&lt;/dependency&gt;</span>
+<span class="nt">&lt;/dependencies&gt;</span>
+</pre></div>
+
+
+<p>See the <a href="downloads.html#epsg">download</a> page for more information
about Maven dependency declaration.</p>
+<h2 id="maven-embedded">As embedded database<a class="headerlink" href="#maven-embedded"
title="Permanent link">&para;</a></h2>
+<p>With <code>sis-embedded-data</code> artifact on the classpath, there
is no need to setup environment variable, Java property or JNDI.
+However this simplicity come with the following inconvenient: a larger download, no option
for choosing which data to use
+(and consequently which license to accept), no possibility to choose the database engine
(i.e. the database software is
+fixed to Derby), and no possibility to add user data (i.e. the database is read-only).
+This dependency can be declared as below (note that <code>sis-epsg</code> should
<em>not</em> be specified in the same project than <code>sis-embedded-data</code>):</p>
+<div class="codehilite"><pre><span class="nt">&lt;dependencies&gt;</span>
+  <span class="nt">&lt;dependency&gt;</span>
+    <span class="nt">&lt;groupId&gt;</span>org.apache.sis.non-free<span
class="nt">&lt;/groupId&gt;</span>
+    <span class="nt">&lt;artifactId&gt;</span>sis-embedded-data<span
class="nt">&lt;/artifactId&gt;</span>
+    <span class="nt">&lt;version&gt;</span>${sis.version}<span class="nt">&lt;/version&gt;</span>
+    <span class="nt">&lt;scope&gt;</span>runtime<span class="nt">&lt;/scope&gt;</span>
+  <span class="nt">&lt;/dependency&gt;</span>
+<span class="nt">&lt;/dependencies&gt;</span>
+</pre></div>
+
+
+<p>See the <a href="downloads.html#epsg">download</a> page for more information
about Maven dependency declaration.</p>
 <h1 id="jndi">Use Java Naming and Directory Interface<a class="headerlink" href="#jndi"
title="Permanent link">&para;</a></h1>
 <p>While Apache SIS uses Apache Derby by default, it is also possible to use another
database software like HSQL or PostgreSQL.
+For using an arbitrary database, register a <code>javax.sql.DataSource</code>
instance through the Java Naming and Directory Interface (JNDI).
+That registration can be done programmatically (by Java code) or by configuring XML files
in some environments.
 The database must exist but can be empty, in which case it will be populated with an EPSG
schema when first needed
-if the <code style="white-space:normal">org.apache.sis.non-free:​sis-epsg:​0.7</code>
dependency is on the classpath
-(see <a href="#maven">above section</a>).</p>
-<p>For using an arbitrary database, register a <code>javax.sql.DataSource</code>
instance through the Java Naming and Directory Interface (JNDI).
-That registration can be done programmatically (by Java code) or by configuring XML files
in some environments.</p>
+if the <code style="white-space:normal">org.apache.sis.non-free:​sis-epsg:​0.8</code>
dependency is on the classpath
+(see <a href="#maven-epsg">above section</a>).</p>
 <h2 id="jndi-java">Registration by Java code<a class="headerlink" href="#jndi-java"
title="Permanent link">&para;</a></h2>
 <p>Registration can be done by the following Java code, provided that a JNDI implementation
is available on the classpath:</p>
 <div class="codehilite"><pre><span class="c1">// Example using PostgreSQL
data source (org.postgresql.ds.PGSimpleDataSource)</span>



Mime
View raw message