Automated commit on Wed Aug 1 17:48:48 BST 2012

rjw57 · Aug 1, 2012 · ff4b76e · ff4b76e
1 parent c82273f
commit ff4b76e
Show file tree

Hide file tree

Showing 11 changed files with 182 additions and 11 deletions.
diff --git a/_images/viewer-mockup.png b/_images/viewer-mockup.png
diff --git a/_sources/design.txt b/_sources/design.txt
@@ -25,3 +25,10 @@ Map files
 .. literalinclude:: map_example.yaml
     :language: yaml
     :linenos:
+
+Web GUI
+-------
+
+.. figure:: viewer-mockup.png
+
+    An example design for the map viewer GUI.
diff --git a/_sources/reference.txt b/_sources/reference.txt
@@ -13,6 +13,12 @@ Geometry manipulation and querying
 .. automodule:: foldbeam.geometry
     :members:
 
+Storing geographic data sets
+----------------------------
+
+.. automodule:: foldbeam.bucket
+    :members:
+
 Rendering
 ---------
 

diff --git a/design.html b/design.html
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '',
-        VERSION:     '2012-07-17',
+        VERSION:     '2012-08-01',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -156,6 +156,13 @@ <h2>Map files<a class="headerlink" href="#map-files" title="Permalink to this he
 </pre></div>
 </td></tr></table></div>
 </div>
+<div class="section" id="web-gui">
+<h2>Web GUI<a class="headerlink" href="#web-gui" title="Permalink to this headline">¶</a></h2>
+<div class="figure">
+<img alt="_images/viewer-mockup.png" src="_images/viewer-mockup.png" />
+<p class="caption">An example design for the map viewer GUI.</p>
+</div>
+</div>
 </div>
 
 
@@ -168,6 +175,7 @@ <h3><a href="index.html">Table Of Contents</a></h3>
   <ul>
 <li><a class="reference internal" href="#">Design notes</a><ul>
 <li><a class="reference internal" href="#map-files">Map files</a></li>
+<li><a class="reference internal" href="#web-gui">Web GUI</a></li>
 </ul>
 </li>
 </ul>

diff --git a/genindex.html b/genindex.html
@@ -17,7 +17,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '',
-        VERSION:     '2012-07-17',
+        VERSION:     '2012-08-01',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -52,7 +52,8 @@ <h3>Navigation</h3>
 <h1 id="index">Index</h1>
 
 <div class="genindex-jumpbox">
- <a href="#B"><strong>B</strong></a>
+ <a href="#A"><strong>A</strong></a>
+ | <a href="#B"><strong>B</strong></a>
  | <a href="#C"><strong>C</strong></a>
  | <a href="#D"><strong>D</strong></a>
  | <a href="#E"><strong>E</strong></a>
@@ -61,6 +62,7 @@ <h1 id="index">Index</h1>
  | <a href="#I"><strong>I</strong></a>
  | <a href="#L"><strong>L</strong></a>
  | <a href="#M"><strong>M</strong></a>
+ | <a href="#N"><strong>N</strong></a>
  | <a href="#O"><strong>O</strong></a>
  | <a href="#P"><strong>P</strong></a>
  | <a href="#R"><strong>R</strong></a>
@@ -70,10 +72,24 @@ <h1 id="index">Index</h1>
  | <a href="#W"><strong>W</strong></a>
 
 </div>
+<h2 id="A">A</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%" valign="top"><dl>
+
+  <dt><a href="reference.html#foldbeam.bucket.Bucket.add">add() (foldbeam.bucket.Bucket method)</a>
+  </dt>
+
+  </dl></td>
+</tr></table>
+
 <h2 id="B">B</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%" valign="top"><dl>
 
+  <dt><a href="reference.html#foldbeam.bucket.BadFileNameError">BadFileNameError</a>
+  </dt>
+
+
   <dt><a href="reference.html#foldbeam.core.Envelope.bottom_right">bottom_right() (foldbeam.core.Envelope method)</a>
   </dt>
 
@@ -91,6 +107,10 @@ <h2 id="B">B</h2>
   <dt><a href="reference.html#foldbeam.core.boundary_from_envelope">boundary_from_envelope() (in module foldbeam.core)</a>
   </dt>
 
+
+  <dt><a href="reference.html#foldbeam.bucket.Bucket">Bucket (class in foldbeam.bucket)</a>
+  </dt>
+
   </dl></td>
 </tr></table>
 
@@ -138,6 +158,10 @@ <h2 id="F">F</h2>
   </dt>
 
 
+  <dt><a href="reference.html#module-foldbeam.bucket">foldbeam.bucket (module)</a>
+  </dt>
+
+
   <dt><a href="reference.html#module-foldbeam.core">foldbeam.core (module)</a>
   </dt>
 
@@ -214,15 +238,25 @@ <h2 id="L">L</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%" valign="top"><dl>
 
+  <dt><a href="reference.html#foldbeam.bucket.Layer">Layer (class in foldbeam.bucket)</a>
+  </dt>
+
+
   <dt><a href="reference.html#foldbeam.renderer.base.Layers">Layers (class in foldbeam.renderer.base)</a>
   </dt>
 
   </dl></td>
   <td style="width: 33%" valign="top"><dl>
 
-  <dt><a href="reference.html#foldbeam.renderer.base.Layers.layers">layers (foldbeam.renderer.base.Layers attribute)</a>
+  <dt><a href="reference.html#foldbeam.bucket.Bucket.layers">layers (foldbeam.bucket.Bucket attribute)</a>
+  </dt>
+
+      <dd><dl>
+
+  <dt><a href="reference.html#foldbeam.renderer.base.Layers.layers">(foldbeam.renderer.base.Layers attribute)</a>
   </dt>
 
+      </dl></dd>
   </dl></td>
 </tr></table>
 
@@ -236,6 +270,16 @@ <h2 id="M">M</h2>
   </dl></td>
 </tr></table>
 
+<h2 id="N">N</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%" valign="top"><dl>
+
+  <dt><a href="reference.html#foldbeam.bucket.Layer.name">name (foldbeam.bucket.Layer attribute)</a>
+  </dt>
+
+  </dl></td>
+</tr></table>
+
 <h2 id="O">O</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%" valign="top"><dl>
@@ -268,6 +312,10 @@ <h2 id="P">P</h2>
   </dt>
 
 
+  <dt><a href="reference.html#foldbeam.bucket.Bucket.primary_file_name">primary_file_name (foldbeam.bucket.Bucket attribute)</a>
+  </dt>
+
+
   <dt><a href="reference.html#foldbeam.core.ProjectionError">ProjectionError</a>
   </dt>
 
@@ -318,6 +366,10 @@ <h2 id="S">S</h2>
   </dl></td>
   <td style="width: 33%" valign="top"><dl>
 
+  <dt><a href="reference.html#foldbeam.bucket.Layer.spatial_reference">spatial_reference (foldbeam.bucket.Layer attribute)</a>
+  </dt>
+
+
   <dt><a href="reference.html#foldbeam.renderer.geometry.Geometry.stroke">stroke (foldbeam.renderer.geometry.Geometry attribute)</a>
   </dt>
 
@@ -335,12 +387,12 @@ <h2 id="T">T</h2>
   <dt><a href="reference.html#foldbeam.goodies.tilestache.TileStacheProvider">TileStacheProvider (class in foldbeam.goodies.tilestache)</a>
   </dt>
 
-  </dl></td>
-  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="reference.html#foldbeam.core.Envelope.top_left">top_left() (foldbeam.core.Envelope method)</a>
   </dt>
 
+  </dl></td>
+  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="reference.html#foldbeam.core.Boundary.transform_to">transform_to() (foldbeam.core.Boundary method)</a>
   </dt>
@@ -351,6 +403,10 @@ <h2 id="T">T</h2>
   </dt>
 
       </dl></dd>
+
+  <dt><a href="reference.html#foldbeam.bucket.Layer.type">type (foldbeam.bucket.Layer attribute)</a>
+  </dt>
+
   </dl></td>
 </tr></table>
 

diff --git a/index.html b/index.html
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '',
-        VERSION:     '2012-07-17',
+        VERSION:     '2012-08-01',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -69,12 +69,14 @@ <h1>Contents<a class="headerlink" href="#contents" title="Permalink to this head
 <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="reference.html#module-foldbeam.core">Core functionality</a></li>
 <li class="toctree-l2"><a class="reference internal" href="reference.html#module-foldbeam.geometry">Geometry manipulation and querying</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference.html#module-foldbeam.bucket">Storing geographic data sets</a></li>
 <li class="toctree-l2"><a class="reference internal" href="reference.html#module-foldbeam.renderer">Rendering</a></li>
 <li class="toctree-l2"><a class="reference internal" href="reference.html#module-foldbeam.goodies">Other &#8216;goodies&#8217;</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="design.html">Design notes</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="design.html#map-files">Map files</a></li>
+<li class="toctree-l2"><a class="reference internal" href="design.html#web-gui">Web GUI</a></li>
 </ul>
 </li>
 </ul>

diff --git a/objects.inv b/objects.inv
diff --git a/py-modindex.html b/py-modindex.html
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '',
-        VERSION:     '2012-07-17',
+        VERSION:     '2012-08-01',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -66,6 +66,11 @@ <h1>Python Module Index</h1>
        <td>
        <tt class="xref">foldbeam</tt></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&nbsp;&nbsp;&nbsp;
+       <a href="reference.html#module-foldbeam.bucket"><tt class="xref">foldbeam.bucket</tt></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&nbsp;&nbsp;&nbsp;

diff --git a/reference.html b/reference.html
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '',
-        VERSION:     '2012-07-17',
+        VERSION:     '2012-08-01',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -285,6 +285,92 @@ <h1>Reference<a class="headerlink" href="#reference" title="Permalink to this he
 
 </dd></dl>
 
+</div>
+<div class="section" id="module-foldbeam.bucket">
+<span id="storing-geographic-data-sets"></span><h2>Storing geographic data sets<a class="headerlink" href="#module-foldbeam.bucket" title="Permalink to this headline">¶</a></h2>
+<p>Defines a mechanism for persistent storage of geographic data sets in a way which allows for progressive update of
+information such as extent and spatial reference.</p>
+<dl class="exception">
+<dt id="foldbeam.bucket.BadFileNameError">
+<em class="property">exception </em><tt class="descclassname">foldbeam.bucket.</tt><tt class="descname">BadFileNameError</tt><a class="headerlink" href="#foldbeam.bucket.BadFileNameError" title="Permalink to this definition">¶</a></dt>
+<dd><p>Raised when one attempts to use a bad file name in a bucket. A bad file name is one which contains path
+separators and other &#8216;special&#8217; characters in it.</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="foldbeam.bucket.Bucket">
+<em class="property">class </em><tt class="descclassname">foldbeam.bucket.</tt><tt class="descname">Bucket</tt><big>(</big><em>storage_dir</em><big>)</big><a class="headerlink" href="#foldbeam.bucket.Bucket" title="Permalink to this definition">¶</a></dt>
+<dd><p>A bucket is a single unit of data storage corresponding with, usually, a single data source file. For example
+this might be a single shapefile or a single raster. This single file is called the &#8216;primary file&#8217;. There may be
+other files associated with the file. For example, a .SHP file may have an associated .PRJ, .SHX and .DBF file.</p>
+<p>A bucket is similar to a single directory with the restriction that there may be no sub-directories. Files are added
+to the bucket via the <a class="reference internal" href="#foldbeam.bucket.Bucket.add" title="foldbeam.bucket.Bucket.add"><tt class="xref py py-meth docutils literal"><span class="pre">add()</span></tt></a> method. The first file added becomes the &#8216;primary file&#8217;.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>storage_dir</strong> (<em>str</em>) &#8211; a pathname to the directory files within this bucket are stored</td>
+</tr>
+</tbody>
+</table>
+<dl class="method">
+<dt id="foldbeam.bucket.Bucket.add">
+<tt class="descname">add</tt><big>(</big><em>name</em>, <em>fobj</em><big>)</big><a class="headerlink" href="#foldbeam.bucket.Bucket.add" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add a file named <cite>name</cite> to the bucket reading its contents from the file-like object <cite>fobj</cite>.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name" colspan="2">Raises BadFileNameError:</th></tr>
+<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">When <cite>name</cite> is not a raw file name but has, e.g., a directory separator.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="foldbeam.bucket.Bucket.layers">
+<tt class="descname">layers</tt><a class="headerlink" href="#foldbeam.bucket.Bucket.layers" title="Permalink to this definition">¶</a></dt>
+<dd><p>A read only sequence of layers within this bucket. Each element is an object exposing the <a class="reference internal" href="#foldbeam.bucket.Layer" title="foldbeam.bucket.Layer"><tt class="xref py py-class docutils literal"><span class="pre">Layer</span></tt></a>
+interface. If the files within the bucket cannot yet be interpreted as a geographic data set then this attribute
+is an empty sequence.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="foldbeam.bucket.Bucket.primary_file_name">
+<tt class="descname">primary_file_name</tt><a class="headerlink" href="#foldbeam.bucket.Bucket.primary_file_name" title="Permalink to this definition">¶</a></dt>
+<dd><p>The file name for the &#8216;primary&#8217; file in the bucket. It is this file from which data is loaded. Other files
+within the bucket should be auxiliary to this file. (E.g. they should contain projection information.)</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="foldbeam.bucket.Layer">
+<em class="property">class </em><tt class="descclassname">foldbeam.bucket.</tt><tt class="descname">Layer</tt><a class="headerlink" href="#foldbeam.bucket.Layer" title="Permalink to this definition">¶</a></dt>
+<dd><p>An interface for objects returned as layers within a bucket.</p>
+<dl class="attribute">
+<dt id="foldbeam.bucket.Layer.name">
+<tt class="descname">name</tt><a class="headerlink" href="#foldbeam.bucket.Layer.name" title="Permalink to this definition">¶</a></dt>
+<dd><p>A human-readable name for the layer.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="foldbeam.bucket.Layer.spatial_reference">
+<tt class="descname">spatial_reference</tt><a class="headerlink" href="#foldbeam.bucket.Layer.spatial_reference" title="Permalink to this definition">¶</a></dt>
+<dd><p>An instance of <tt class="xref py py-class docutils literal"><span class="pre">osgeo.osr.SpatialReference</span></tt> giving the spatial reference for this layer or <cite>None</cite>
+if no such spatial reference is available.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="foldbeam.bucket.Layer.type">
+<tt class="descname">type</tt><a class="headerlink" href="#foldbeam.bucket.Layer.type" title="Permalink to this definition">¶</a></dt>
+<dd><p>Either <tt class="xref py py-attr docutils literal"><span class="pre">Layer.VECTOR_TYPE</span></tt> or <tt class="xref py py-attr docutils literal"><span class="pre">Layer.RASTER_TYPE</span></tt> depending on whether this layer
+is a vector or raster layer.</p>
+</dd></dl>
+
+</dd></dl>
+
 </div>
 <div class="section" id="module-foldbeam.renderer">
 <span id="rendering"></span><h2>Rendering<a class="headerlink" href="#module-foldbeam.renderer" title="Permalink to this headline">¶</a></h2>
@@ -551,6 +637,7 @@ <h3><a href="index.html">Table Of Contents</a></h3>
 <li><a class="reference internal" href="#">Reference</a><ul>
 <li><a class="reference internal" href="#module-foldbeam.core">Core functionality</a></li>
 <li><a class="reference internal" href="#module-foldbeam.geometry">Geometry manipulation and querying</a></li>
+<li><a class="reference internal" href="#module-foldbeam.bucket">Storing geographic data sets</a></li>
 <li><a class="reference internal" href="#module-foldbeam.renderer">Rendering</a><ul>
 <li><a class="reference internal" href="#module-foldbeam.renderer.base">Base functionality</a></li>
 <li><a class="reference internal" href="#module-foldbeam.renderer.tile_fetcher">Tiles from &#8216;slippy&#8217; maps</a></li>

diff --git a/search.html b/search.html
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '',
-        VERSION:     '2012-07-17',
+        VERSION:     '2012-08-01',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true