fr.ifremer.coser.command

Class Command

java.lang.Object

fr.ifremer.coser.command.Command

Direct Known Subclasses:

CategoryLineCommand, MergeSpeciesCommand

public abstract class Command
extends Object

Command interface.

Author:

chatellier

Field Summary

Fields

Modifier and Type	Field and Description
protected String	commandUUID UUID de la commande.
protected String	comment Command comment.

Constructor Summary

Constructors

Constructor and Description
Command()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	doCommand(Project project, AbstractDataContainer container) Do command on project.
abstract void	fromStringRepresentation(String representation) Init command from string representation.
String	getCommandUUID() UUID de la commande.
String	getComment() Command comment.
abstract String	getDescription(Project project, AbstractDataContainer container) Return human readable string for ui display (used in selection replay, and undo redo commands).
abstract String	getLogString(Project project, AbstractDataContainer container) Return human readable string for log output.
void	setCommandUUID(String commandUUID) UUID de la commande.
void	setComment(String comment) Command comment.
abstract String	toStringRepresentation() Get command argument string representation.
abstract void	undoCommand(Project project, AbstractDataContainer container) Undo command on project.

Methods inherited from class java.lang.Object

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

Field Detail

commandUUID

protected String commandUUID

UUID de la commande. Les commandes ayant un UUID commun font partie du même groupe de commandes.

comment

protected String comment

Command comment.

Constructor Detail

Command

public Command()

Method Detail

getCommandUUID

public String getCommandUUID()

UUID de la commande. Les commandes ayant un UUID commun font partie du même groupe de commandes.

Returns:

command UUID

See Also:

UUID

setCommandUUID

public void setCommandUUID(String commandUUID)

UUID de la commande. Les commandes ayant un UUID commun font partie du même groupe de commandes.

Parameters:

commandUUID - new uuid

See Also:

UUID

getComment

public String getComment()

Command comment.

Returns:

command comment

setComment

public void setComment(String comment)

Command comment.

Parameters:

comment - command comment

doCommand

public abstract void doCommand(Project project,
             AbstractDataContainer container)
                        throws CoserBusinessException

Do command on project.

Parameters:

project - project

container - container

Throws:

CoserBusinessException

undoCommand

public abstract void undoCommand(Project project,
               AbstractDataContainer container)
                          throws CoserBusinessException

Undo command on project.

Parameters:

project - project

container - container

Throws:

CoserBusinessException

toStringRepresentation

public abstract String toStringRepresentation()

Get command argument string representation.

Returns:

command argument string representation

fromStringRepresentation

public abstract void fromStringRepresentation(String representation)

Init command from string representation.

Parameters:

representation - string command representation

getLogString

public abstract String getLogString(Project project,
                  AbstractDataContainer container)

Return human readable string for log output.

Parameters:

project - used to convert species code

container - rarement utile, mais dans certains cas, sert a avoir les vrais valeur de champs au lieu des noms techniques

Returns:

log representation

getDescription

public abstract String getDescription(Project project,
                    AbstractDataContainer container)

Return human readable string for ui display (used in selection replay, and undo redo commands).

Parameters:

project - used to convert species code

container - rarement utile, mais dans certains cas, sert a avoir les vrais valeur de champs au lieu des noms techniques

Returns:

string description (i18n)