Changeset 24941 in osm for applications/editors

Timestamp:

2011-01-02T12:10:26+01:00 (14 years ago)

Author:

oliverw

Message:

Added documentation.

File:

• applications/editors/josm/plugins/FixAddresses/src/org/openstreetmap/josm/plugins/fixAddresses/OsmUtils.java (modified) (5 diffs)

applications/editors/josm/plugins/FixAddresses/src/org/openstreetmap/josm/plugins/fixAddresses/OsmUtils.java

@@ -98 +98 @@
         
         /**
-         * Gets the associated street name via relation of the address node, if present.
-         *
-         * @param address the address
-         * @return true, if an associated street has been found.
+         * Checks, if the given address has a relation hosting the address values. This method looks
+         * for a relation of type 'associatedStreet' and checks the members for address values, if present.
+         * If the member has address values, this methods sets the derived properties of the address
+         * node accordingly. 
+         *
+         * @param address The address to check.
+         * @return true, if an associated relation has been found.
          */
         public static boolean getValuesFromRelation(OSMAddress address) {
@@ -111 +114 @@
                 OsmPrimitive addrNode = address.getOsmObject();
                 
+                // check all referrers of the node
                 for (OsmPrimitive osm : addrNode.getReferrers()) {
                         if (osm instanceof Relation) {
                                 Relation r = (Relation) osm;
-                                
+                                // Relation has the right type?
                                 if (!TagUtils.isAssociatedStreetRelation(r)) continue;
                                 
+                                // check for 'street' members 
                                 for (RelationMember rm : r.getMembers()) {
                                         if (TagUtils.isStreetMember(rm)) {
                                                 OsmPrimitive street = rm.getMember();
-                                                if (TagUtils.hasHighwayTag(street)) {
+                                                if (TagUtils.hasHighwayTag(street)) {                                                   
                                                         String streetName = TagUtils.getNameValue(street);
                                                         if (!StringUtils.isNullOrEmpty(streetName)) {
+                                                                // street name found -> set property
                                                                 address.setDerivedValue(TagUtils.ADDR_STREET_TAG, streetName);
                                                                 hasValuesFromRel = true;
                                                                 break;
-                                                        }
-                                                } // TODO: Issue a warning here                                         
+                                                        } // else: Street has no name: Ooops
+                                                } // else: Street member, but no highway tag: Ooops                                             
                                         }
                                 }
@@ -152 +158 @@
          * Gets the tag values from an address interpolation ref, if present.
          *
-         * @param address the address
-         * @return the values from address interpolation
+         * @param address The address
+         * @return true, if house numbers are given via address interpolation; otherwise false.
          */
         public static boolean getValuesFromAddressInterpolation(OSMAddress address) {
@@ -178 +184 @@
         
         /**
-         * Gets the locale code as string.
-         *
-         * @return the locale
+         * Gets the local code as string.
+         *
+         * @return the string representation of the local.
          */
         public static String getLocale() {
@@ -191 +197 @@
         }
 
+        /**
+         * Helper method to set an derived value of an address node.
+         *
+         * @param address The address to change
+         * @param w the way containing the tag for the derived value.
+         * @param tag the tag to set as applied value.
+         */
         private static void applyDerivedValue(OSMAddress address, Way w, String tag) {
                 if (!address.hasTag(tag) && TagUtils.hasTag(w, tag)) {