Changeset 33409 in osm for applications/editors/josm/plugins/pt_assistant

Timestamp:

2017-06-22T18:49:05+02:00 (7 years ago)

Author:

giackserva

Message:

[pt_assistant] javadoc

Location:

applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/actions

Files:

• AddStopPositionAction.java (modified) (3 diffs)
• EdgeSelectionAction.java (modified) (4 diffs)
• EditHighlightedRelationsAction.java (modified) (3 diffs)
• SplitRoundaboutAction.java (modified) (2 diffs)

applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/actions/AddStopPositionAction.java

@@ -24 +24 @@
 import org.openstreetmap.josm.tools.Shortcut;
 
-/*
+/**
  * The AddStopPositionAction is a mapmode that allows users to add
  * new stop_positions or to convert already existing nodes.
+ *
+ * @author giacomo
  */
 @SuppressWarnings("serial")
 public class AddStopPositionAction extends MapMode {
+
+        private static final String mapModeName = "Add stop position";
 
         private transient Set<OsmPrimitive> newHighlights = new HashSet<>();
@@ -37 +41 @@
     private final Cursor cursorJoinWay;
 
+    /**
+     * Creates a new AddStopPositionAction
+     */
         public AddStopPositionAction() {
-                super(tr("Add stop position"),
-                                "bus",
-                                tr("Add stop position"),
+                super(tr(mapModeName), "bus", tr(mapModeName),
                                 Shortcut.registerShortcut("mapmode:stop_position",
-                        tr("Mode: {0}", tr("Add stop position")),
+                        tr("Mode: {0}", tr(mapModeName)),
                         KeyEvent.VK_K, Shortcut.CTRL_SHIFT),
                                 getCursor());
@@ -167 +172 @@
         newHighlights.clear();
     }
-
 }

applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/actions/EdgeSelectionAction.java

@@ -21 +21 @@
 import org.openstreetmap.josm.tools.Shortcut;
 
+/**
+ * The action allows to select a set of consecutive ways at once in order to
+ * speed up the mapper. The selected ways are going to be coherent to the
+ * current route the mapper is working on.
+ *
+ * @author giacomo
+ */
 public class EdgeSelectionAction extends MapMode {
 
-        private Set<Way> highlighted;
+        private static final String mapModeName = "Edge Selection";
+        private static final long serialVersionUID = 2414977774504904238L;
+
+        private transient  Set<Way> highlighted;
+
         private Cursor selectionCursor;
         private Cursor waySelectCursor;
 
-        private static final long serialVersionUID = 2414977774504904238L;
-
         public EdgeSelectionAction() {
-                super(tr("Edge Selection"),
-                                "edgeSelection",
-                                tr("Edge Selection"),
+                super(tr(mapModeName), "edgeSelection", tr(mapModeName),
                                 Shortcut.registerShortcut("mapmode:edge_selection",
-                        tr("Mode: {0}", tr("Edge Selection")),
+                        tr("Mode: {0}", tr(mapModeName)),
                         KeyEvent.VK_K, Shortcut.CTRL),
                                 ImageProvider.getCursor("normal", "selection"));
@@ -47 +54 @@
      * to the edge
      */
-    private List<Way> getEdgeFromWay(Way initial, String modeOfTravel)
-    {
+    private List<Way> getEdgeFromWay(Way initial, String modeOfTravel) {
         List<Way> edge = new ArrayList<>();
         if(!isWaySuitableForMode(initial, modeOfTravel))
@@ -77 +83 @@
     }
 
-    private Boolean isWaySuitableForMode(Way toCheck, String modeOfTravel)
-    {
+    private Boolean isWaySuitableForMode(Way toCheck, String modeOfTravel) {
         if("bus".equals(modeOfTravel))
                 return RouteUtils.isWaySuitableForBuses(toCheck);
@@ -88 +93 @@
      *
      */
-    private Way chooseBestWay(List<Way> ways, String modeOfTravel)
-    {
+    private Way chooseBestWay(List<Way> ways, String modeOfTravel) {
         ways.removeIf(w -> !isWaySuitableForMode(w, modeOfTravel));
         if(ways.isEmpty())

applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/actions/EditHighlightedRelationsAction.java

@@ -16 +16 @@
 
 /**
- * Gives the user the possibility to edit the current highlighted relation without selecting it again
+ * Gives the user the possibility to edit the current highlighted relation
+ * without selecting it again
  *
  * @author giacomo
@@ -23 +24 @@
 public class EditHighlightedRelationsAction extends JosmAction {
 
+    private static final String actionName = "Edit Highlighted Relation";
     private static final long serialVersionUID = 2681464946469047054L;
 
-    private static final String actionName = "Edit Highlighted Relation";
-
     /**
-     * Default constructor
+     * Creates a new EditHighlightedRelationsAction
      */
     public EditHighlightedRelationsAction() {
@@ -37 +37 @@
     }
 
-    /**
-     * Applies the fixes, resets the last fix attribute
-     */
     @Override
     public void actionPerformed(ActionEvent e) {

applications/editors/josm/plugins/pt_assistant/src/org/openstreetmap/josm/plugins/pt_assistant/actions/SplitRoundaboutAction.java

@@ -32 +32 @@
 import org.openstreetmap.josm.plugins.pt_assistant.utils.RouteUtils;
 
-/*
+/**
+ * This action allows the user to split a selected roundabout.
+ * The action will look for ways going in and out of the roudabout
+ * which also are member of a public transport route. Having found
+ * those, the roundabout will be split on the common points between
+ * the ways and it. The routes will be fixed by connecting the entry
+ * point to the exit point of the roundabout.
+ *
+ *      @author giacomo
  */
 public class SplitRoundaboutAction extends JosmAction {
@@ -39 +47 @@
         private static final long serialVersionUID = 8912249304286025356L;
 
+        /**
+         * Creates a new SplitRoundaboutAction
+         */
         public SplitRoundaboutAction() {
                 super(actionName, "icons/splitroundabout", actionName, null, true);