Class documentation
authorAndy Allan <andy@gravitystorm.co.uk>
Wed, 22 Jun 2011 14:40:47 +0000 (15:40 +0100)
committerAndy Allan <andy@gravitystorm.co.uk>
Wed, 22 Jun 2011 14:40:47 +0000 (15:40 +0100)
net/systemeD/halcyon/connection/Connection.as
net/systemeD/halcyon/connection/XMLConnection.as
net/systemeD/potlatch2/utils/SnapshotConnection.as
net/systemeD/potlatch2/utils/SnapshotLoader.as

index 61d8872..148f605 100644 (file)
@@ -574,6 +574,9 @@ package net.systemeD.halcyon.connection {
 
         // these are functions that the Connection implementation is expected to
         // provide. This class has some generic helpers for the implementation.
+        /**
+        * Load data for the bounding box given. Usually called in response to pan / zoom requests
+        */
                public function loadBbox(left:Number, right:Number,
                                                                top:Number, bottom:Number):void {
            }
index 3a4c5ef..d420da9 100644 (file)
@@ -13,9 +13,19 @@ package net.systemeD.halcyon.connection {
     /**
     * XMLConnection provides all the methods required to connect to a live
     * OSM server. See OSMConnection for connecting to a read-only .osm file
+    *
+    * @see OSMConnection
     */
        public class XMLConnection extends XMLBaseConnection {
 
+        /**
+        * Create a new XML connection
+        * @param name The name of the connection
+        * @param api The url of the OSM API server, e.g. http://api06.dev.openstreetmap.org/api/0.6/
+        * @param policy The url of the flash crossdomain policy to load,
+                        e.g. http://api06.dev.openstreetmap.org/api/crossdomain.xml
+        * @param initparams Any further parameters for the connection, such as the serverName
+        */
                public function XMLConnection(name:String,api:String,policy:String,initparams:Object) {
 
                        super(name,api,policy,initparams);
index 96322c2..a374a06 100644 (file)
@@ -4,6 +4,13 @@ package net.systemeD.potlatch2.utils {
     import flash.events.Event;
     import flash.net.*;
 
+    /**
+    * A connection to a Snapshot server. A Snapshot server serves OSM map requests and can also
+    * track the "status" of an entity. Most other types of XMLConnection requests will fail. See
+    * http://www.github.com/gravitystorm/snapshot-server for example code based on the database
+    * structure created by osmosis pgsnapshot schema.
+    */
+
     public class SnapshotConnection extends XMLConnection {
 
         public function SnapshotConnection(cname:String,api:String,policy:String,initparams:Object=null) {
@@ -13,7 +20,9 @@ package net.systemeD.potlatch2.utils {
 
         // As it stands, the following two functions could be refactored further.
 
-        /** Post a status update call to the server and update entity.status if successful */
+        /**
+        * Post a status update call to the server and update entity.status if successful.
+        */
         public function markComplete(entity:Entity):void {
             var urlReq:URLRequest;
 
@@ -31,7 +40,9 @@ package net.systemeD.potlatch2.utils {
             }
         }
 
-        /** Send a "complete" call to the server and update entity.status if successful */
+        /**
+        * Send a "complete" call to the server and update entity.status if successful.
+        */
         public function markNotComplete(entity:Entity):void {
             var urlReq:URLRequest;
 
index 1f76d34..f89634b 100644 (file)
@@ -4,6 +4,12 @@ package net.systemeD.potlatch2.utils {
     import net.systemeD.halcyon.MapPaint;
     import net.systemeD.potlatch2.utils.SnapshotConnection;
 
+    /**
+    * Loads a Snapshot layer. Uses lazy-loading such that only when the load() function is
+    * called will the layer be created and added to the map
+    *
+    * @see SnapShotConnection
+    */
     public class SnapshotLoader {
 
         private var map:Map;
@@ -12,7 +18,14 @@ package net.systemeD.potlatch2.utils {
         private var connection:SnapshotConnection;
         private var _stylesheet:String;
 
-
+        /**
+        * Create a new SnapshotLoader
+        * @param map The map object to attach the layer to
+        * @param url The url of the snapshot server. This should be to the api base and
+                     end in a forward slash, e.g. http://example.com/snapshot/api/
+        * @param name The name to give to the layer/connection
+        * @param stylesheet The url of the stylesheet to use for styling the layer
+        */
         public function SnapshotLoader(map:Map, url:String, name:String, stylesheet:String = null):void {
             trace("*"+stylesheet+"*")
             this.map = map;
@@ -20,6 +33,11 @@ package net.systemeD.potlatch2.utils {
             _stylesheet = (stylesheet && stylesheet != '') ? stylesheet : STYLESHEET;
         }
 
+        /**
+        * Load the layer.
+        * Call this the first time you wish to load the layer. After this it will respond
+        * automatically to pan / zooming of the associated Map
+        */
         public function load():void {
             if (!_layer) {
                 _layer = map.addLayer(connection, _stylesheet, true, true);