org.eclipse.emf.mapping.command
Class RestoreInitialStateCommand

java.lang.Object
  org.eclipse.emf.common.command.AbstractCommand
      org.eclipse.emf.mapping.command.RestoreInitialStateCommand

All Implemented Interfaces:

Command

public class RestoreInitialStateCommand
extends AbstractCommand

The restore initial state command ensures that the mapping root is ready to begin a mapping session from a defined initial state. This implementation just deletes all the mappings, which is good for pure meet-in-the-middle mapping. For pure top down mapping, a derived implementation will want to reset the outputs.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.emf.common.command.AbstractCommand

AbstractCommand.NonDirtying

Field Summary

protected static java.lang.String	DESCRIPTION This cachaes the description.
protected MappingDomain	domain This keeps track of the mapping domain in which the command operates.
protected static java.lang.String	LABEL This caches the label.

Fields inherited from class org.eclipse.emf.common.command.AbstractCommand

description, isExecutable, isPrepared, label

Constructor Summary

RestoreInitialStateCommand(MappingDomain domain)
This creates a command instance that removes the mappings in the collection from the mapping root.

Method Summary

static Command	create(MappingDomain domain) This creates a command that removes the mapping from the mapping root.
void	dispose() Called to indicate that the command will never be used again.
void	execute() Performs the command activity required for the effect.
protected boolean	prepare() Called at most once in AbstractCommand.canExecute() to give the command an opportunity to ready itself for execution.
void	redo() Performs the command activity required to redo the effect after undoing the effect.
java.lang.String	toString() This gives an abbreviated name using this object's own class' name, without package qualification, followed by a space separated list of field:value pairs.
void	undo() Throws a runtime exception.

Methods inherited from class org.eclipse.emf.common.command.AbstractCommand

canExecute, canUndo, chain, getAffectedObjects, getDescription, getLabel, getResult, setDescription, setLabel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LABEL

protected static final java.lang.String LABEL

This caches the label.

DESCRIPTION

protected static final java.lang.String DESCRIPTION

This cachaes the description.

domain

protected MappingDomain domain

This keeps track of the mapping domain in which the command operates.

Constructor Detail

RestoreInitialStateCommand

public RestoreInitialStateCommand(MappingDomain domain)

This creates a command instance that removes the mappings in the collection from the mapping root.

Method Detail

create

public static Command create(MappingDomain domain)

This creates a command that removes the mapping from the mapping root.

prepare

protected boolean prepare()

Description copied from class: AbstractCommand

Called at most once in AbstractCommand.canExecute() to give the command an opportunity to ready itself for execution. The returned value is stored in AbstractCommand.canExecute(). In other words, you can override this method to initialize and to yield a cached value for the all subsequent calls to canExecute.

Overrides:

prepare in class AbstractCommand

Returns:

whether the command is executable.

execute

public void execute()

Description copied from interface: Command

Performs the command activity required for the effect. The effect of calling execute when canExecute returns false, or when canExecute hasn't been called, is undefined.

undo

public void undo()

Description copied from class: AbstractCommand

Throws a runtime exception.

Specified by:

undo in interface Command

Overrides:

undo in class AbstractCommand

redo

public void redo()

Description copied from interface: Command

Performs the command activity required to redo the effect after undoing the effect. The effect, if any, of calling redo before undo is called is undefined. Note that if you implement redo to call execute then any derived class will be restricted by that decision also.

dispose

public void dispose()

Description copied from interface: Command

Called to indicate that the command will never be used again. Calling any other method after this one has undefined results.

Specified by:

dispose in interface Command

Overrides:

dispose in class AbstractCommand

toString

public java.lang.String toString()

This gives an abbreviated name using this object's own class' name, without package qualification, followed by a space separated list of field:value pairs.

Overrides:

toString in class AbstractCommand

Returns:

string representation.