Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

Runtime

org.eclipse.gmf.runtime.emf.commands.core.command
Class CompositeTransactionalCommand

java.lang.Object
  extended by 

org.eclipse.core.commands.operations.AbstractOperation
      extended by org.eclipse.emf.workspace.AbstractEMFOperation
          extended by org.eclipse.emf.workspace.CompositeEMFOperation
              extended by 
org.eclipse.gmf.runtime.emf.commands.core.command.CompositeTransactionalCommand
All Implemented Interfaces:
IUndoableOperation, ICommand, ICompositeCommand, org.eclipse.gmf.runtime.common.core.internal.command.ICommandWithSettableResult

public class CompositeTransactionalCommand
extends org.eclipse.emf.workspace.CompositeEMFOperation
implements ICompositeCommand, org.eclipse.gmf.runtime.common.core.internal.command.ICommandWithSettableResult

An undoable operation that is composed of child IUndoableOperations that are expected to modify EMF model resources.

The operation provides a list of IFiles that are expected to be modified when the operation is executed, undone or redone. An IOperationApprover is registered with the OperationHistoryFactory.getOperationHistory() to validate the modification to these resources.

This class is meant to be instantiated by clients.


Constructor Summary
CompositeTransactionalCommand (org.eclipse.emf.transaction.TransactionalEditingDomain domain, java.lang.String label)
          Initializes me with the editing domain in which I am making model changes and a label.
CompositeTransactionalCommand (org.eclipse.emf.transaction.TransactionalEditingDomain domain, java.lang.String label, java.util.List children)
          Initializes me with the editing domain, a label, and child operations.
CompositeTransactionalCommand (org.eclipse.emf.transaction.TransactionalEditingDomain domain, java.lang.String label, java.util.List children, java.util.Map options)
          Initializes me with the editing domain, a label, and child operations, and transaction options.
CompositeTransactionalCommand (org.eclipse.emf.transaction.TransactionalEditingDomain domain, java.lang.String label, java.util.Map options)
          Initializes me with the editing domain, a label, and transaction options.
 
Method Summary
protected   IStatus aggregateStatuses (java.util.List statuses)
          Overrides the superclass implementation to set the command result.
 boolean canExecute ()
          I can execute if I am not empty and all of my children can execute.
 boolean canRedo ()
          I can redo if I am not empty and all my children can all be redone.
 boolean canUndo ()
          I can undo if I am not empty and all my children can all be undone.
  ICommand compose ( IUndoableOperation operation)
          Returns a new command object that represents a composition of this command with the specified command parameter.
 java.util.List getAffectedFiles ()
          Returns the IFiles for resources that may be modified when the operation is executed, undone or redone.
  CommandResult getCommandResult ()
          Retrieves the result of executing, undoing, or redoing this command, depending on which of these operations was last performed.
protected  java.util.List getReturnValues ()
          Returns a list containing all of the return values from ICommand children.
 void internalSetResult ( CommandResult result)
          Deprecated. internal API
 boolean isEmpty ()
          Answers whether or not this composite operation has children.
  ICommand reduce ()
          Returns the simplest form of this command that is equivalent.
protected  void setResult ( CommandResult result)
          Sets the command result.
 
Methods inherited from class org.eclipse.emf.workspace.CompositeEMFOperation
add, assertNotExecuted, didCommit, dispose, doExecute, doRedo, doUndo, getChildren, isTransactionNestingEnabled, iterator, listIterator, listIterator, remove, setReuseParentTransaction, setTransactionNestingEnabled, size
 
Methods inherited from class org.eclipse.emf.workspace.AbstractEMFOperation
canSetOptions, didRedo, didUndo, execute, getChange, getEditingDomain, getOptions, isReuseParentTransaction, redo, setOptions, undo
 
Methods inherited from class org.eclipse.core.commands.operations. AbstractOperation
addContext, getContexts, getLabel, hasContext, removeContext, setLabel, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.gmf.runtime.common.core.command. ICompositeCommand
add, iterator, listIterator, listIterator, remove, size
 
Methods inherited from interface org.eclipse.gmf.runtime.common.core.command. ICommand
setLabel
 
Methods inherited from interface org.eclipse.core.commands.operations. IUndoableOperation
addContext, dispose, execute, getContexts, getLabel, hasContext, redo, removeContext, undo
 

Constructor Detail

CompositeTransactionalCommand

public CompositeTransactionalCommand(org.eclipse.emf.transaction.TransactionalEditingDomain domain,
                                     java.lang.String label)
Initializes me with the editing domain in which I am making model changes and a label.

Parameters:
domain - my editing domain
label - my user-readable label, should never be null.

CompositeTransactionalCommand

public CompositeTransactionalCommand(org.eclipse.emf.transaction.TransactionalEditingDomain domain,
                                     java.lang.String label,
                                     java.util.Map options)
Initializes me with the editing domain, a label, and transaction options.

Parameters:
domain - my editing domain
label - my user-readable label, should never be null.
options - for the transaction in which I execute myself, or null for the default options

CompositeTransactionalCommand

public CompositeTransactionalCommand(org.eclipse.emf.transaction.TransactionalEditingDomain domain,
                                     java.lang.String label,
                                     java.util.List children)
Initializes me with the editing domain, a label, and child operations.

Parameters:
domain - my editing domain
label - my user-readable label, should never be null.
children - a list of operations to compose

CompositeTransactionalCommand

public CompositeTransactionalCommand(org.eclipse.emf.transaction.TransactionalEditingDomain domain,
                                     java.lang.String label,
                                     java.util.List children,
                                     java.util.Map options)
Initializes me with the editing domain, a label, and child operations, and transaction options.

Parameters:
domain - my editing domain
label - my user-readable label, should never be null.
children - a list of operations to compose
options - for the transaction in which I execute myself, or null for the default options
Method Detail

getAffectedFiles

public java.util.List getAffectedFiles()
Returns the IFiles for resources that may be modified when the operation is executed, undone or redone.

Specified by:
getAffectedFiles in interface ICommand
Returns:
the list of IFiles that will be modified

getCommandResult

public 
CommandResult getCommandResult()
Description copied from interface: ICommand
Retrieves the result of executing, undoing, or redoing this command, depending on which of these operations was last performed. This value can be null if the operation has no meaningful result.

The value of this result is undefined if the command has not yet been executed, undone or redone.

Specified by:
getCommandResult in interface ICommand
Returns:
The result of executing, undoing or redoing this command.

setResult

protected void setResult(
CommandResult result)
Sets the command result.

Parameters:
result - the new result for this command.

getReturnValues

protected java.util.List getReturnValues()
Returns a list containing all of the return values from ICommand children.


aggregateStatuses

protected 
IStatus aggregateStatuses(java.util.List statuses)
Overrides the superclass implementation to set the command result.

Overrides:
aggregateStatuses in class org.eclipse.emf.workspace.AbstractEMFOperation

compose

public final 
ICommand compose(
IUndoableOperation operation)
Description copied from interface: ICommand
Returns a new command object that represents a composition of this command with the specified command parameter.

Specified by:
compose in interface ICommand
Parameters:
operation - The operation that is to be composed with this command.
Returns:
A command that represents a composition of this command with the specified command.

reduce

public 
ICommand reduce()
Returns the simplest form of this command that is equivalent. This is useful for removing unnecessary nesting of commands.

If the composite has a single command, it returns the reduction of that single command. Otherwise, it returns itself.

Specified by:
reduce in interface ICommand
Returns:
the simplest form of this command that is equivalent

isEmpty

public final boolean isEmpty()
Answers whether or not this composite operation has children.

Specified by:
isEmpty in interface ICompositeCommand
Returns:
true if the operation does not have children, false otherwise.

canExecute

public boolean canExecute()
I can execute if I am not empty and all of my children can execute.

Specified by:
canExecute in interface IUndoableOperation
Overrides:
canExecute in class org.eclipse.emf.workspace.CompositeEMFOperation

canRedo

public boolean canRedo()
I can redo if I am not empty and all my children can all be redone.

Specified by:
canRedo in interface IUndoableOperation
Overrides:
canRedo in class org.eclipse.emf.workspace.CompositeEMFOperation

canUndo

public boolean canUndo()
I can undo if I am not empty and all my children can all be undone.

Specified by:
canUndo in interface IUndoableOperation
Overrides:
canUndo in class org.eclipse.emf.workspace.CompositeEMFOperation

internalSetResult

public void internalSetResult(
CommandResult result)
Deprecated. internal API

Internal method to set the command result.

Specified by:
internalSetResult in interface org.eclipse.gmf.runtime.common.core.internal.command.ICommandWithSettableResult
Parameters:
result - CommandResult to set

Runtime

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp., Borland Software Corp., and others 2005,2006. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire