org.openstreetmap.josm.command

Class Command

java.lang.Object

org.openstreetmap.josm.command.PseudoCommand

org.openstreetmap.josm.command.Command

Direct Known Subclasses:

AddCommand, AddPrimitivesCommand, ChangeCommand, ChangeNodesCommand, ChangePropertyCommand, ChangePropertyKeyCommand, ChangeRelationMemberRoleCommand, ConflictAddCommand, ConflictResolveCommand, DeleteCommand, MoveCommand, PurgeCommand, RemoveNodesCommand, SelectCommand, SequenceCommand, TransformNodesCommand

public abstract class Command
extends PseudoCommand

Classes implementing Command modify a dataset in a specific way. A command is one atomic action on a specific dataset, such as move or delete. The command remembers the OsmDataLayer it is operating on.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	Command.CloneVisitor
static class	Command.OldNodeState Small helper for holding the interesting part of the old data state of the objects.

Field Summary

Fields

Modifier and Type	Field and Description
private Map<OsmPrimitive,PrimitiveData>	cloneMap the map of OsmPrimitives in the original state to OsmPrimitives in cloned state
private OsmDataLayer	layer the layer which this command is applied to

Constructor Summary

Constructors

Constructor and Description
Command() Creates a new command in the context of the current edit layer, if any
Command(OsmDataLayer layer) Creates a new command in the context of a specific data layer

Method Summary

Modifier and Type	Method and Description
static boolean	checkAndConfirmOutlyingOperation(String operation, String dialogTitle, String outsideDialogMessage, String incompleteDialogMessage, Collection<? extends OsmPrimitive> primitives, Collection<? extends OsmPrimitive> ignore) Check whether user is about to operate on data outside of the download area.
boolean	equals(Object obj)
boolean	executeCommand() Executes the command on the dataset.
abstract void	fillModifiedData(Collection<OsmPrimitive> modified, Collection<OsmPrimitive> deleted, Collection<OsmPrimitive> added) Fill in the changed data this command operates on.
protected OsmDataLayer	getLayer() Replies the layer this command is (or was) applied to.
PrimitiveData	getOrig(OsmPrimitive osm) Lets other commands access the original version of the object.
Collection<? extends OsmPrimitive>	getParticipatingPrimitives() Return the primitives that take part in this command.
int	hashCode()
boolean	invalidBecauselayerRemoved(Layer oldLayer) Called when a layer has been removed to have the command remove itself from any buffer if it is not longer applicable to the dataset (e.g.
void	undoCommand() Undoes the command.

Methods inherited from class org.openstreetmap.josm.command.PseudoCommand

getChildren, getDescriptionIcon, getDescriptionText

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

cloneMap

private Map<OsmPrimitive,PrimitiveData> cloneMap

the map of OsmPrimitives in the original state to OsmPrimitives in cloned state

layer

private final OsmDataLayer layer

the layer which this command is applied to

Constructor Detail

Command

public Command()

Creates a new command in the context of the current edit layer, if any

Command

public Command(OsmDataLayer layer)

Creates a new command in the context of a specific data layer

Parameters:

layer - the data layer. Must not be null.

Throws:

IllegalArgumentException - if layer is null

Method Detail

executeCommand

public boolean executeCommand()

Executes the command on the dataset. This implementation will remember all primitives returned by fillModifiedData for restoring them on undo.

Returns:

true

undoCommand

public void undoCommand()

Undoes the command. It can be assumed that all objects are in the same state they were before. It can also be assumed that executeCommand was called exactly once before. This implementation undoes all objects stored by a former call to executeCommand.

invalidBecauselayerRemoved

public boolean invalidBecauselayerRemoved(Layer oldLayer)

Called when a layer has been removed to have the command remove itself from any buffer if it is not longer applicable to the dataset (e.g. it was part of the removed layer)

Parameters:

oldLayer - the old layer

Returns:

true if this command

getOrig

public PrimitiveData getOrig(OsmPrimitive osm)

Lets other commands access the original version of the object. Usually for undoing.

Parameters:

osm - The requested OSM object

Returns:

The original version of the requested object, if any

getLayer

protected OsmDataLayer getLayer()

Replies the layer this command is (or was) applied to.

Returns:

the layer this command is (or was) applied to

fillModifiedData

public abstract void fillModifiedData(Collection<OsmPrimitive> modified,
                                      Collection<OsmPrimitive> deleted,
                                      Collection<OsmPrimitive> added)

Fill in the changed data this command operates on. Add to the lists, don't clear them.

Parameters:

modified - The modified primitives

deleted - The deleted primitives

added - The added primitives

getParticipatingPrimitives

public Collection<? extends OsmPrimitive> getParticipatingPrimitives()

Return the primitives that take part in this command. The collection is computed during execution.

Specified by:

getParticipatingPrimitives in class PseudoCommand

Returns:

primitives that take part in this command

checkAndConfirmOutlyingOperation

public static boolean checkAndConfirmOutlyingOperation(String operation,
                                                       String dialogTitle,
                                                       String outsideDialogMessage,
                                                       String incompleteDialogMessage,
                                                       Collection<? extends OsmPrimitive> primitives,
                                                       Collection<? extends OsmPrimitive> ignore)

Check whether user is about to operate on data outside of the download area. Request confirmation if he is.

Parameters:

operation - the operation name which is used for setting some preferences

dialogTitle - the title of the dialog being displayed

outsideDialogMessage - the message text to be displayed when data is outside of the download area

incompleteDialogMessage - the message text to be displayed when data is incomplete

primitives - the primitives to operate on

ignore - null or a primitive to be ignored

Returns:

true, if operating on outlying primitives is OK; false, otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object