From bf1c91ae126b37d53cd16ea17f394544c1abc414 Mon Sep 17 00:00:00 2001 From: Davide Savazzi Date: Mon, 16 Aug 2010 16:28:50 +0200 Subject: [PATCH] added some javadoc --- .../udig/catalog/neo4j/Activator.java | 18 +++++++++++++++--- .../neo4j/DeleteNeo4jSpatialLayerOp.java | 2 ++ .../catalog/neo4j/Neo4jSpatialService.java | 3 +++ .../catalog/neo4j/ProgressMonitorWrapper.java | 3 +++ .../neo4j/RefreshNeo4jSpatialServiceOp.java | 3 +++ .../neo4j/findpath/FindPathConstants.java | 4 ++++ .../catalog/neo4j/findpath/FindPathTool.java | 5 +++++ .../findpath/GenerateLineStringNetworkOp.java | 6 ++++-- .../neo4j/findpath/GraphMapGraphic.java | 2 ++ .../catalog/neo4j/findpath/WayPointTool.java | 2 ++ .../neo4j/shpwizard/ShpImportWizard.java | 2 ++ 11 files changed, 45 insertions(+), 5 deletions(-) diff --git a/src/net/refractions/udig/catalog/neo4j/Activator.java b/src/net/refractions/udig/catalog/neo4j/Activator.java index e115443..ac7ac7f 100644 --- a/src/net/refractions/udig/catalog/neo4j/Activator.java +++ b/src/net/refractions/udig/catalog/neo4j/Activator.java @@ -23,6 +23,9 @@ /** + * Neo4j Plugin Activator. + * It mantains an index of open Neo4j DataStores. + * * @author Davide Savazzi */ public class Activator extends AbstractUIPlugin { @@ -41,6 +44,9 @@ public Activator() { // Public methods + /** + * Return a Neo4j DataStore. + */ public Neo4jSpatialDataStore getDataStore(Map params) throws IOException { if (dataStorefactory.canProcess(params)) { String id = dataStorefactory.getDataStoreUniqueIdentifier(params); @@ -60,6 +66,9 @@ public Neo4jSpatialDataStore getDataStore(Map params) thro } } + /** + * Close all open DataStores. + */ public void stop(BundleContext context) throws Exception { plugin = null; @@ -67,9 +76,6 @@ public void stop(BundleContext context) throws Exception { for (String id : openDataStores.keySet()) { DataStore dataStore = openDataStores.get(id); dataStore.dispose(); - - // TODO log is already stopped? it throws NPE... - log("Closed Neo4j Database: " + id); } openDataStores.clear(); } @@ -99,10 +105,16 @@ public ILayer findLayer(String layerName, List layers) { return null; } + /** + * Return a static reference to this Activator + */ public static Activator getDefault() { return plugin; } + /** + * Open an Error Message Dialog + */ public static void openError(final Display display, final String title, final String message) { display.asyncExec(new Runnable() { public void run() { diff --git a/src/net/refractions/udig/catalog/neo4j/DeleteNeo4jSpatialLayerOp.java b/src/net/refractions/udig/catalog/neo4j/DeleteNeo4jSpatialLayerOp.java index 9c92055..b0e49e1 100644 --- a/src/net/refractions/udig/catalog/neo4j/DeleteNeo4jSpatialLayerOp.java +++ b/src/net/refractions/udig/catalog/neo4j/DeleteNeo4jSpatialLayerOp.java @@ -14,6 +14,8 @@ /** + * IOp implementation to completely delete a Neo4j Layer. + * * @author Davide Savazzi */ public class DeleteNeo4jSpatialLayerOp implements IOp { diff --git a/src/net/refractions/udig/catalog/neo4j/Neo4jSpatialService.java b/src/net/refractions/udig/catalog/neo4j/Neo4jSpatialService.java index 3cec7f8..bcc04fd 100644 --- a/src/net/refractions/udig/catalog/neo4j/Neo4jSpatialService.java +++ b/src/net/refractions/udig/catalog/neo4j/Neo4jSpatialService.java @@ -84,6 +84,9 @@ public Map getConnectionParams() { return params; } + /** + * Clear Neo4j Datastore cache. + */ public void refresh(IProgressMonitor monitor) { Neo4jSpatialDataStore dataStore = (Neo4jSpatialDataStore) getDataStore(monitor); dataStore.clearCache(); diff --git a/src/net/refractions/udig/catalog/neo4j/ProgressMonitorWrapper.java b/src/net/refractions/udig/catalog/neo4j/ProgressMonitorWrapper.java index 176fc7a..5e80578 100644 --- a/src/net/refractions/udig/catalog/neo4j/ProgressMonitorWrapper.java +++ b/src/net/refractions/udig/catalog/neo4j/ProgressMonitorWrapper.java @@ -6,6 +6,9 @@ /** + * Implementation of a Neo4j-Spatial Listener that + * manage an Eclipse IProgressMonitor implementation. + * * @author Davide Savazzi */ public class ProgressMonitorWrapper implements Listener { diff --git a/src/net/refractions/udig/catalog/neo4j/RefreshNeo4jSpatialServiceOp.java b/src/net/refractions/udig/catalog/neo4j/RefreshNeo4jSpatialServiceOp.java index 6c35c7b..4b5332f 100644 --- a/src/net/refractions/udig/catalog/neo4j/RefreshNeo4jSpatialServiceOp.java +++ b/src/net/refractions/udig/catalog/neo4j/RefreshNeo4jSpatialServiceOp.java @@ -7,6 +7,9 @@ /** + * IOp implementation to refresh a Neo4j DataStore. + * Useful after Layer creation or deletion, it deletes Neo4j DataStore internal cache. + * * @author Davide Savazzi */ public class RefreshNeo4jSpatialServiceOp implements IOp { diff --git a/src/net/refractions/udig/catalog/neo4j/findpath/FindPathConstants.java b/src/net/refractions/udig/catalog/neo4j/findpath/FindPathConstants.java index e7dddba..9a550ee 100644 --- a/src/net/refractions/udig/catalog/neo4j/findpath/FindPathConstants.java +++ b/src/net/refractions/udig/catalog/neo4j/findpath/FindPathConstants.java @@ -1,5 +1,9 @@ package net.refractions.udig.catalog.neo4j.findpath; + +/** + * Constants used in uDig Blackboard by the Find Shortest Path tool. + */ public interface FindPathConstants { String BLACKBOARD_WAYPOINTS = "neo4j_waypoints"; diff --git a/src/net/refractions/udig/catalog/neo4j/findpath/FindPathTool.java b/src/net/refractions/udig/catalog/neo4j/findpath/FindPathTool.java index 166bb50..a5a1e50 100644 --- a/src/net/refractions/udig/catalog/neo4j/findpath/FindPathTool.java +++ b/src/net/refractions/udig/catalog/neo4j/findpath/FindPathTool.java @@ -30,6 +30,11 @@ import org.neo4j.graphdb.Transaction; +/** + * Tool to find the shortest path between selected waypoints, using Dijkstra algorithm. + * + * @author Davide Savazzi + */ public class FindPathTool extends AbstractActionTool implements FindPathConstants { // Public methods diff --git a/src/net/refractions/udig/catalog/neo4j/findpath/GenerateLineStringNetworkOp.java b/src/net/refractions/udig/catalog/neo4j/findpath/GenerateLineStringNetworkOp.java index d0cb366..0b4bb3a 100644 --- a/src/net/refractions/udig/catalog/neo4j/findpath/GenerateLineStringNetworkOp.java +++ b/src/net/refractions/udig/catalog/neo4j/findpath/GenerateLineStringNetworkOp.java @@ -16,18 +16,18 @@ import org.neo4j.gis.spatial.Constants; import org.neo4j.gis.spatial.DefaultLayer; import org.neo4j.gis.spatial.EditableLayer; -import org.neo4j.gis.spatial.Layer; import org.neo4j.gis.spatial.LineStringNetworkGenerator; import org.neo4j.gis.spatial.Search; import org.neo4j.gis.spatial.SpatialDatabaseRecord; import org.neo4j.gis.spatial.SpatialDatabaseService; -import org.neo4j.gis.spatial.WKBGeometryEncoder; import org.neo4j.gis.spatial.geotools.data.Neo4jSpatialDataStore; import org.neo4j.gis.spatial.query.SearchAll; import org.neo4j.graphdb.Transaction; /** + * IOp implementation to create a network of LineStrings. + * * @author Davide Savazzi */ public class GenerateLineStringNetworkOp implements IOp { @@ -63,9 +63,11 @@ public void op(Display display, Object target, IProgressMonitor monitor) throws try { // TODO put these layer nodes in relationship? + // create Network Points Layer EditableLayer netPointsLayer = spatialDatabase.getOrCreateEditableLayer(layer.getName() + " - network points"); netPointsLayer.setCoordinateReferenceSystem(layer.getCoordinateReferenceSystem()); + // create Network Edges Layer EditableLayer netEdgesLayer = spatialDatabase.getOrCreateEditableLayer(layer.getName() + " - network edges"); netEdgesLayer.setCoordinateReferenceSystem(layer.getCoordinateReferenceSystem()); diff --git a/src/net/refractions/udig/catalog/neo4j/findpath/GraphMapGraphic.java b/src/net/refractions/udig/catalog/neo4j/findpath/GraphMapGraphic.java index a2a9808..472d7db 100644 --- a/src/net/refractions/udig/catalog/neo4j/findpath/GraphMapGraphic.java +++ b/src/net/refractions/udig/catalog/neo4j/findpath/GraphMapGraphic.java @@ -19,6 +19,8 @@ /** + * MapGraphic that draws selected waypoints and the shortest path found between them. + * * TODO style support */ public class GraphMapGraphic implements MapGraphic, FindPathConstants { diff --git a/src/net/refractions/udig/catalog/neo4j/findpath/WayPointTool.java b/src/net/refractions/udig/catalog/neo4j/findpath/WayPointTool.java index 4f7a9d1..534da86 100644 --- a/src/net/refractions/udig/catalog/neo4j/findpath/WayPointTool.java +++ b/src/net/refractions/udig/catalog/neo4j/findpath/WayPointTool.java @@ -26,6 +26,8 @@ /** + * Tool to select waypoints on the map. + * * @author Davide Savazzi */ public class WayPointTool extends SimpleTool implements FindPathConstants { diff --git a/src/net/refractions/udig/catalog/neo4j/shpwizard/ShpImportWizard.java b/src/net/refractions/udig/catalog/neo4j/shpwizard/ShpImportWizard.java index 78b67ca..3938e12 100644 --- a/src/net/refractions/udig/catalog/neo4j/shpwizard/ShpImportWizard.java +++ b/src/net/refractions/udig/catalog/neo4j/shpwizard/ShpImportWizard.java @@ -28,6 +28,8 @@ /** + * Wizard to import a Shapefile in a Neo4j DataStore. + * * @author Davide Savazzi */ public class ShpImportWizard extends Wizard implements INewWizard {