Context Navigation

openstreetmap

Timestamp:

2010-11-06T18:33:54+01:00 (14 years ago)

Author:

oliverw

Message:

Added documentation / removed some compiler warnings.

Location:

Files:

-              r24028
+              r24088
 import org.xml.sax.SAXException;
+/**
+ * The class AddressFinderThread scans the data set to find the best guess for a missing address field.
+ *
+ * The guessing procedure itself is implemented by defining "guessers" using the {@link GuessedValueHandler}
+ * class. A guessed field does not modify the corresponding property of {@link AddressNode} itself, but
+ * adds the guessed value to a shadowed field by calling {@link AddressNode#setGuessedValue(String, String)}.
+ */
 public class AddressFinderThread extends PleaseWaitRunnable implements Visitor {
         private List<AddressNode> addressesToGuess;
 …
         private double minDist;
         private AddressNode curAddressNode;
+        private boolean isRunning = false;
+        private String nearestName = null;
+        private String currentName = null;
+        private boolean isRunning = false;
         private boolean cancelled;
 …
                 if (dist < minDist) {
                         minDist = dist;
-                        nearestName = currentName;
+                }
+        }
 …
                 if (!TagUtils.hasNameTag(w)) return;
-                currentName = TagUtils.getNameValue(w);
                 for (Node node : w.getNodes()) {
                         visit(node);

-              r24028
+              r24088
 import org.openstreetmap.josm.data.osm.OsmPrimitive;
+/**
+ * The class AddressNode represents a single address node of OSM. It is a lightweight
+ * wrapper for a OSM node in order to simplify tag handling.
+ */
 public class AddressNode extends NodeEntityBase {
         public static final String MISSING_TAG = "?";

-              r23964
+              r24088
 import org.openstreetmap.josm.plugins.PluginInformation;
+/**
+ * The Class FixAddressesPlugin is the main entry point for the plugin.
+ */
 public class FixAddressesPlugin extends Plugin {
         /**
          * Constructor for the AddressEdit plugin.
+         * Constructor for the AddressEdit plugin. Called by JOSM when loading the plugin.
          * @param info Context information of the plugin.
          */

-              r24028
+              r24088
 /**
+ * Action to find and fix addresses without (valid) streets.
+ * Action to find and fix addresses without (valid) streets. It launches an dialog
+ * instance of {@link AddressEditDialog}.
+ *
  * @author Oliver Wieland <oliver.wieland@online.de>
+ *
  */
+@SuppressWarnings("serial")
 public class FixUnresolvedStreetsAction extends JosmAction implements SelectionChangedListener {
-        /**
+         *
-         */
-        private static final long serialVersionUID = 1L;
         private AddressEditContainer addressEditContainer;
         private Collection<? extends OsmPrimitive> newSelection;

-              r24028
+              r24088
  * The guess is determined by finding the closest way/node with the given tag. If no appropriate node
  * is found within maximum distance, no guess is made.
+ *
+ * The default maximum distance is 100m.
  */
 public class GuessedValueHandler implements Visitor {

-              r23970
+              r24088
          * Called by a node entity if a command has been created. Clients may collect
          * these commands to define a sequence command.
          * @param entity
          * @param command
+         * @param entity The entity which created/used the command.
+         * @param command The command instance to process by the enclosing command listener.
          */
         public void commandIssued(INodeEntity entity, Command command);

-              r23971
+              r24088
 import org.openstreetmap.josm.data.osm.Way;
+/**
+ * The class NodeEntityBase provides a base implementation for the {@link INodeEntity} interface.
+ *
+ * The implementation comprises
+ * <ol>
+ * <li>Handle change listeners
+ * <li>Links the corresponding OSM object
+ * <li>Tag handling
+ * </ol>
+ */
 public class NodeEntityBase implements INodeEntity, Comparable<INodeEntity> {
         public static final String ANONYMOUS = tr("No name");

Note: See TracChangeset for help on using the changeset viewer.