de.cau.cs.kieler.core.model.effects
Class TransformationEffect

java.lang.Object
  extended by de.cau.cs.kieler.core.kivi.AbstractEffect
      extended by de.cau.cs.kieler.core.model.effects.TransformationEffect
All Implemented Interfaces:
IEffect
Direct Known Subclasses:
XtendTransformationEffect

public class TransformationEffect
extends AbstractEffect

A KiVi effect that executes a specific transformation.

Rating green
(2011-02-14) review by msp, haf

Constructor Summary
TransformationEffect()
          default constructor.
TransformationEffect(ITransformationContext context, TransformationDescriptor descriptor)
           
TransformationEffect(ITransformationContext context, TransformationDescriptor descriptor, boolean monitored)
           
 
Method Summary
 void execute()
          Execute the effect.
 Object getResult()
           
 void setContext(ITransformationContext context)
           
 void setDescriptor(TransformationDescriptor descriptor)
           
 
Methods inherited from class de.cau.cs.kieler.core.kivi.AbstractEffect
isMergeable, merge, schedule, scheduleUndo, toString, undo
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TransformationEffect

public TransformationEffect()
default constructor.


TransformationEffect

public TransformationEffect(ITransformationContext context,
                            TransformationDescriptor descriptor)
Parameters:
context - ITransformationContext containing all necessary information in order to execute the transformation.
descriptor - The transformation's TransformationDescriptor

TransformationEffect

public TransformationEffect(ITransformationContext context,
                            TransformationDescriptor descriptor,
                            boolean monitored)
Parameters:
context - ITransformationContext containing all necessary information in order to execute the transformation.
descriptor - The transformation's TransformationDescriptor.
monitored - Determines whether the execution should be processed as a monitored operation.
Method Detail

execute

public void execute()
Execute the effect.


getResult

public Object getResult()
Returns:
the result of the executed transformation.

setContext

public void setContext(ITransformationContext context)
Parameters:
context - the context to set

setDescriptor

public void setDescriptor(TransformationDescriptor descriptor)
Parameters:
descriptor - the descriptor to set