g-Eclipse
Release 1.0.0

eu.geclipse.jsdl.parametric
Interface IParametricJsdlHandler


public interface IParametricJsdlHandler

Handler passed to IParametricJsdlGenerator. Methods from that interface are called during generation JSDLs for Parametric JSDL.
It's useful to control generation process (e.g. serialization of generated JSDL or tracking substitution of parameters).


Method Summary
 void generationFinished()
          Called after last JSDL was generated
 void generationStarted(int generatedJsdls, java.util.List<java.lang.String> paramNames)
          Called, when sweep jsdl is successfully validated and generation process is starting
 boolean isCanceled()
           
 void newJsdlGenerated(IGeneratedJsdl generatedJsdl)
          Called, when all parameters were substituted and new generated jsdl is ready.
 

Method Detail

generationStarted

void generationStarted(int generatedJsdls,
                       java.util.List<java.lang.String> paramNames)
                       throws ParametricJsdlException
Called, when sweep jsdl is successfully validated and generation process is starting

Parameters:
generatedJsdls - number of JSDLs, which will be generated (number of iterations)
paramNames - list of XPath queries selecting nodes, which values will be replaced during generation
Throws:
ParametricJsdlException - may be thrown in case on error in order to interrupt generation process

generationFinished

void generationFinished()
                        throws ParametricJsdlException
Called after last JSDL was generated

Throws:
ParametricJsdlException - may be thrown in case on error in order to interrupt generation process

newJsdlGenerated

void newJsdlGenerated(IGeneratedJsdl generatedJsdl)
                      throws ParametricJsdlException
Called, when all parameters were substituted and new generated jsdl is ready. Now you can store it on disk, show for user, submit etc

Parameters:
generatedJsdl - new instance of jsdl
monitor - progress monitor
Throws:
ParametricJsdlException - may be thrown in case on error in order to interrupt generation process

isCanceled

boolean isCanceled()
Returns:
true if generation process is cancelled and should be interrupted

g-Eclipse
Release 1.0.0