|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.emf.common.command.AbstractCommand
org.eclipse.emf.mapping.command.CreateMappingCommand
The create mapping command creates a new mapping in a MappingDomain
from a set of the domain's input and output objects.
Nested Class Summary |
Nested classes inherited from class org.eclipse.emf.common.command.AbstractCommand |
AbstractCommand.NonDirtying |
Field Summary | |
protected static String |
DESCRIPTION
This cachaes the description. |
protected MappingDomain |
domain
This keeps track of the mapping domain in which the command operates. |
static int |
ENABLE_ALL
Deprecated. - use MappingDomain.ENABLE_ALL |
static int |
ENABLE_EMPTY_INPUTS
Deprecated. - use MappingDomain.ENABLE_EMPTY_INPUTS |
static int |
ENABLE_EMPTY_OUTPUTS
Deprecated. - use MappingDomain.ENABLE_EMPTY_OUTPUTS |
static int |
ENABLE_INCOMPATIBLE_METAOBJECTS
Deprecated. - use MappingDomain.ENABLE_INCOMPATIBLE_METAOBJECTS |
static int |
ENABLE_INCOMPATIBLE_TYPE_CLASSIFIERS
Deprecated. - use MappingDomain.ENABLE_INCOMPATIBLE_TYPE_CLASSIFIERS |
static int |
ENABLE_MAPPED_INPUTS
Deprecated. - use MappingDomain.ENABLE_MULTIPLE_INPUT_MAPPINGS |
static int |
ENABLE_MAPPED_OUTPUTS
Deprecated. - use MappingDomain.ENABLE_MULTIPLE_OUTPUT_MAPPINGS |
static int |
ENABLE_MULTIPLE_INPUTS
Deprecated. - use MappingDomain.ENABLE_MULTIPLE_INPUTS |
static int |
ENABLE_MULTIPLE_OUTPUTS
Deprecated. - use MappingDomain.ENABLE_MULTIPLE_OUTPUTS |
static int |
ENABLE_UNMAPPED_PARENTS
Deprecated. - use MappingDomain.ENABLE_UNMAPPED_PARENTS |
protected Collection |
inputs
This keeps track of the input objects that are to be mapped. |
protected static String |
LABEL
This caches the label. |
protected Mapping |
newMapping
This is set during execute() to record the new mapping that is created. |
protected Collection |
outputs
This keeps track of the output objects that are to be mapped. |
protected Command |
subcommand
This is set during execute() to record the command used to add the newly created mapping to the mapping root. |
Fields inherited from class org.eclipse.emf.common.command.AbstractCommand |
description, isExecutable, isPrepared, label |
Constructor Summary | |
CreateMappingCommand(MappingDomain domain,
Collection collection)
This creates a command that creates a new mapping involving the given domain's collection of input and output objects. |
|
CreateMappingCommand(MappingDomain domain,
Collection collection,
int enablementFlags)
Deprecated. |
Method Summary | |
static Command |
create(MappingDomain domain,
Collection collection)
This creates a command that creates a new mapping involving the given domain's collection of input and output objects. |
static Command |
create(MappingDomain domain,
Collection inputs,
Collection outputs)
This creates a command that creates a new mapping with the given collections of inputs and outputs. |
static Command |
create(MappingDomain domain,
Collection inputs,
Object output)
This creates a command that creates a new mapping with the given collection of inputs and output. |
static Command |
create(MappingDomain domain,
Object input,
Collection outputs)
This creates a command that creates a new mapping with the given input and collection of outputs. |
static Command |
create(MappingDomain domain,
Object input,
Object output)
This creates a command that creates a new mapping between the given input and output. |
void |
dispose()
Called to indicate that the command will never be used again. |
void |
execute()
Performs the command activity required for the effect. |
Collection |
getAffectedObjects()
Returns an empty list. |
String |
getDescription()
Returns a string suitable to help describe the effect of this command. |
String |
getLabel()
Returns a string suitable to represent the label that identifies this command. |
Collection |
getResult()
Returns an empty list. |
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.
|
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, setDescription, setLabel |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int ENABLE_MULTIPLE_INPUTS
public static final int ENABLE_MULTIPLE_OUTPUTS
public static final int ENABLE_MAPPED_INPUTS
public static final int ENABLE_MAPPED_OUTPUTS
public static final int ENABLE_INCOMPATIBLE_METAOBJECTS
public static final int ENABLE_INCOMPATIBLE_TYPE_CLASSIFIERS
public static final int ENABLE_EMPTY_INPUTS
public static final int ENABLE_EMPTY_OUTPUTS
public static final int ENABLE_UNMAPPED_PARENTS
public static final int ENABLE_ALL
protected static final String LABEL
protected static final String DESCRIPTION
protected MappingDomain domain
protected Collection inputs
protected Collection outputs
protected Mapping newMapping
execute()
to record the new mapping that is created.
protected Command subcommand
execute()
to record the command used to add the newly created mapping to the mapping root.
Constructor Detail |
public CreateMappingCommand(MappingDomain domain, Collection collection, int enablementFlags)
public CreateMappingCommand(MappingDomain domain, Collection collection)
Method Detail |
public static Command create(MappingDomain domain, Collection collection)
public static Command create(MappingDomain domain, Object input, Object output)
public static Command create(MappingDomain domain, Collection inputs, Collection outputs)
public static Command create(MappingDomain domain, Collection inputs, Object output)
public static Command create(MappingDomain domain, Object input, Collection outputs)
protected boolean prepare()
AbstractCommand
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.
prepare
in class AbstractCommand
public void execute()
Command
execute
when canExecute
returns false
,
or when canExecute
hasn't been called, is undefined.
public void undo()
AbstractCommand
undo
in interface Command
undo
in class AbstractCommand
public void redo()
Command
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.
public Collection getResult()
AbstractCommand
getResult
in interface Command
getResult
in class AbstractCommand
public Collection getAffectedObjects()
AbstractCommand
getAffectedObjects
in interface Command
getAffectedObjects
in class AbstractCommand
public void dispose()
Command
dispose
in interface Command
dispose
in class AbstractCommand
public String getLabel()
Command
getLabel
in interface Command
getLabel
in class AbstractCommand
public String getDescription()
Command
getDescription
in interface Command
getDescription
in class AbstractCommand
public String toString()
toString
in class AbstractCommand
|
Copyright 2001-2006 IBM Corporation and others. All Rights Reserved. |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |