Changeset 23970 in osm for applications/editors/josm/plugins/FixAddresses/src/org/openstreetmap

Timestamp:

2010-10-31T19:36:05+01:00 (14 years ago)

Author:

oliverw

Message:

• Added action RemoveAddressTagsAction
• Collect all commands within a single transaction per action

Location:

applications/editors/josm/plugins/FixAddresses/src/org/openstreetmap/josm/plugins/fixAddresses

Files:

• AddressNode.java (modified) (1 diff)
• ICommandListener.java (added)
• INodeEntity.java (modified) (1 diff)
• NodeEntityBase.java (modified) (7 diffs)
• gui/AbstractAddressEditAction.java (modified) (3 diffs)
• gui/AddressEditDialog.java (modified) (3 diffs)
• gui/ApplyAllGuessesAction.java (modified) (1 diff)
• gui/AssignAddressToStreetAction.java (modified) (2 diffs)
• gui/RemoveAddressTagsAction.java (added)

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

@@ -171 +171 @@
                 }
                 return TagUtils.getAddrCountryValue(osmObject);
+        }
+        
+        /**
+         * Removes all addresss related tags from the node or way.
+         */
+        public void removeAllAddressTags() {
+                removeOSMTag(TagUtils.ADDR_CITY_TAG);
+                removeOSMTag(TagUtils.ADDR_COUNTRY_TAG);
+                removeOSMTag(TagUtils.ADDR_POSTCODE_TAG);
+                removeOSMTag(TagUtils.ADDR_HOUSENUMBER_TAG);
+                removeOSMTag(TagUtils.ADDR_STATE_TAG);
+                removeOSMTag(TagUtils.ADDR_STREET_TAG);
         }
         

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

@@ -58 +58 @@
          */
         public LatLon getCoor();
+        
+        /**
+         * Adds a command listener.
+         * @param listener
+         */
+        public void addCommandListener(ICommandListener listener);
+        
+        /**
+         * Removes a command listener.
+         * @param listener
+         */
+        public void removeCommandListener(ICommandListener listener);
 }

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

@@ -19 +19 @@
 import java.util.List;
 
-import org.openstreetmap.josm.Main;
-import org.openstreetmap.josm.command.ChangeCommand;
+import org.openstreetmap.josm.command.ChangePropertyCommand;
+import org.openstreetmap.josm.command.Command;
 import org.openstreetmap.josm.data.coor.LatLon;
 import org.openstreetmap.josm.data.osm.BBox;
@@ -29 +29 @@
 public class NodeEntityBase implements INodeEntity, Comparable<INodeEntity> {
         public static final String ANONYMOUS = tr("No name");
-        private static List<IAddressEditContainerListener> listeners = new ArrayList<IAddressEditContainerListener>();
+        private static List<IAddressEditContainerListener> containerListeners = new ArrayList<IAddressEditContainerListener>();
+        private List<ICommandListener> cmdListeners = new ArrayList<ICommandListener>();
         
         protected OsmPrimitive osmObject;
@@ -53 +54 @@
          */
         public static void addChangedListener(IAddressEditContainerListener listener) {
-                listeners.add(listener);
+                containerListeners.add(listener);
         }
         
@@ -61 +62 @@
          */
         public static void removeChangedListener(IAddressEditContainerListener listener) {
-                listeners.remove(listener);
+                containerListeners.remove(listener);
         }
         
@@ -68 +69 @@
          */
         protected static void fireEntityChanged(INodeEntity entity) {
-                for (IAddressEditContainerListener listener : listeners) {
+                for (IAddressEditContainerListener listener : containerListeners) {
                         listener.entityChanged(entity);
                 }
         }
+        
+        /**
+         * Adds a command listener.
+         * @param listener
+         */
+        public void addCommandListener(ICommandListener listener) {
+                cmdListeners.add(listener);
+        }
+        
+        /**
+         * Removes a command listener.
+         * @param listener
+         */
+        public void removeCommandListener(ICommandListener listener) {
+                cmdListeners.remove(listener);
+        }
+        
+        /**
+         * Notifies clients that an entity has issued a command.
+         *
+         * @param source the entity that issued the command.
+         * @param cmd the command to execute.
+         */
+        protected void fireCommandIssued(Command cmd) {
+                if (cmdListeners.size() == 0) {
+                        throw new RuntimeException("Object has no TX context: " + this);
+                }
+                
+                for (ICommandListener l : cmdListeners) {
+                        l.commandIssued(this, cmd);
+                }
+        }       
 
         public OsmPrimitive getOsmObject() {
@@ -79 +112 @@
         @Override
         public List<INodeEntity> getChildren() {
-                // TODO Auto-generated method stub
                 return null;
         }
@@ -109 +141 @@
          * @param tag The tag to change.
          * @param newValue The new value for the tag.
+         * @param cmd The surrounding command sequence
          */
         protected void setOSMTag(String tag, String newValue) {
-                OsmPrimitive oldObject = osmObject;
-                OsmPrimitive newObject = null;
-                        
-                // I would appreciate a clone method...
-                if (oldObject instanceof Node) {
-                        newObject = new Node();
-                } else if (oldObject instanceof Way) {
-                        newObject = new Way();
-                }
+                if (StringUtils.isNullOrEmpty(tag)) return;
                 
-                if (newObject != null) {
-                        newObject.cloneFrom(oldObject);
-                        newObject.put(tag, newValue);
-                        Main.main.undoRedo.add( new ChangeCommand(oldObject, newObject));
+                if (osmObject != null && osmObject.hasKey(tag)) {
+                        fireCommandIssued(new ChangePropertyCommand(osmObject, tag, newValue));
                         fireEntityChanged(this);
-                } else {
-                        throw new RuntimeException("Cannot modify tag for " + osmObject);
-                }
+                } 
+        }
+        
+        /**
+         * Removes the given tag from the OSM object.
+         *
+         * @param tag the tag
+         */
+        protected void removeOSMTag(String tag) {
+                setOSMTag(tag, null); // a value of null removes the tag
         }
 

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

@@ -15 +15 @@
 
 import java.awt.event.ActionEvent;
-
+import java.util.ArrayList;
+import java.util.List;
+
+import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.actions.JosmAction;
+import org.openstreetmap.josm.command.Command;
+import org.openstreetmap.josm.command.SequenceCommand;
 import org.openstreetmap.josm.plugins.fixAddresses.AddressEditContainer;
 import org.openstreetmap.josm.plugins.fixAddresses.IAddressEditContainerListener;
+import org.openstreetmap.josm.plugins.fixAddresses.ICommandListener;
 import org.openstreetmap.josm.plugins.fixAddresses.INodeEntity;
+import org.openstreetmap.josm.plugins.fixAddresses.StringUtils;
 
 /**
@@ -34 +41 @@
 
 @SuppressWarnings("serial")
-public abstract class AbstractAddressEditAction extends JosmAction implements IAddressEditContainerListener {   
+public abstract class AbstractAddressEditAction extends JosmAction implements IAddressEditContainerListener, ICommandListener { 
         private AddressEditSelectionEvent event;
         protected AddressEditContainer container;
+        private List<Command> commands;
+        private String txName;
 
         /**
@@ -167 +176 @@
                 updateEnabledState();           
         }
+        
+        /**
+         * Begins the transaction (command sequence). Must be called by every subclass before
+         * any modification on OSM objects starts.
+         *
+         * @param txName the name of the transaction (e. g. "change address tags").
+         */
+        public void beginTransaction(String txName) {
+                if (commands != null && commands.size() > 0) {
+                        throw new RuntimeException("TX has not been closed (missing finishTransaction?)");
+                }
+                
+                commands = new ArrayList<Command>();
+                if (StringUtils.isNullOrEmpty(txName)) {
+                        throw new RuntimeException("Transaction must have a name");
+                }
+                this.txName = txName;
+        }
+        
+        /**
+         * Finishes the transaction and passes the command sequence to the framework.
+         */
+        public void finishTransaction() {
+                if (commands == null) {
+                        throw new RuntimeException("No command list available. Did you forget to call beginTransaction?");
+                }
+                // execute the command
+                Main.main.undoRedo.add(new SequenceCommand(txName, commands));
+                commands.clear();
+                container.invalidate();
+        }
+        
+        /**
+         * Begins the transaction for a single object.
+         *
+         * @param entity the entity
+         */
+        public void beginObjectTransaction(INodeEntity entity) {
+                if (entity != null) {
+                        entity.addCommandListener(this);
+                } else {
+                        throw new RuntimeException("Entity must not be null");
+                }
+        }
+        
+        /**
+         * Finishes the transaction for a single object.
+         *
+         * @param entity the entity
+         */
+        public void finishObjectTransaction(INodeEntity entity) {
+                if (entity != null) {
+                        entity.removeCommandListener(this);
+                } else {
+                        throw new RuntimeException("Entity must not be null");
+                }
+        }
+        
+        /* (non-Javadoc)
+         * @see org.openstreetmap.josm.plugins.fixAddresses.ICommandListener#commandIssued(org.openstreetmap.josm.plugins.fixAddresses.INodeEntity, org.openstreetmap.josm.command.Command)
+         */
+        @Override
+        public void commandIssued(INodeEntity entity, Command command) {
+                if (commands == null) {
+                        throw new RuntimeException("No command list available. Did you forget to call beginTransaction?");
+                }
+                commands.add(command);
+        }
 }

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

@@ -75 +75 @@
         private GuessAddressDataAction guessAddressAction = new GuessAddressDataAction();
         private SelectAddressesInMapAction selectAddressesInMapAction = new SelectAddressesInMapAction();
+        private RemoveAddressTagsAction removeAddressTagsAction = new RemoveAddressTagsAction();
         
         private AbstractAddressEditAction[] actions = new AbstractAddressEditAction[] {
@@ -80 +81 @@
                 guessAddressAction,
                 applyAllGuessesAction,
-                selectAddressesInMapAction
+                selectAddressesInMapAction,
+                removeAddressTagsAction
         };
         private JLabel streetLabel;
@@ -145 +147 @@
                                 
                                 unresolvedButtons.add(new JSeparator());
+                                
+                                SideButton removeAddressTags = new SideButton(removeAddressTagsAction);                                                                                                                    
+                                unresolvedButtons.add(removeAddressTags);
+                                
+                                unresolvedButtons.add(new JSeparator());
+                                
                                 SideButton selectInMap = new SideButton(selectAddressesInMapAction);                                                                                                                       
                                 unresolvedButtons.add(selectInMap);

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

@@ -50 +50 @@
 
         private void applyGuesses(List<AddressNode> addrToFix) {
+                beginTransaction(tr("Applied guessed values"));
                 List<AddressNode> addrToFixShadow = new ArrayList<AddressNode>(addrToFix);
                 for (AddressNode aNode : addrToFixShadow) {
+                        beginObjectTransaction(aNode);
                         aNode.applyAllGuesses();
+                        finishObjectTransaction(aNode);
                 }
+                finishTransaction();
         }
 

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

@@ -26 +26 @@
  * 
  */
-public class AssignAddressToStreetAction extends AbstractAddressEditAction {
+public class AssignAddressToStreetAction extends AbstractAddressEditAction  {
 
         public AssignAddressToStreetAction() {
@@ -43 +43 @@
         public void addressEditActionPerformed(AddressEditSelectionEvent ev) {          
                 StreetNode streetNode = ev.getSelectedStreet();
-                                
+                                                
                 if (streetNode != null && ev.getSelectedUnresolvedAddresses() != null) {
+                        beginTransaction(tr("Set street name") + " '" + streetNode.getName() + "'");
                         for (AddressNode addrNode : ev.getSelectedUnresolvedAddresses()) {
-                                addrNode.assignStreet(streetNode);                              
+                                beginObjectTransaction(addrNode);
+                                addrNode.assignStreet(streetNode);
+                                finishObjectTransaction(addrNode);
                         }
+                        finishTransaction();
                 }
+                
         }