EvaluationManager

```
public interface EvaluationManager
```
Provides entry-point services to launch an evaluation.
Here is a typical use of the evaluation manager:
- load a launch configuration using loadLaunchConfiguration(File),
- evaluate this configuration using evaluate(LaunchConfiguration, ProgressMonitor).
If a specific project has to be evaluated more than one time in different configurations, or if the templates to be evaluated can be selected dynamically, you can have a finer control on the evaluation process. Here are the steps:
- load a project using loadProject(File),
- optionally inspect the content of this project to select some templates to evaluate,
- instantiate an Evaluable subclass, which describes what is to be evaluated,
- launch the evaluation using evaluate(Project, Evaluable, ProgressMonitor).
An evaluation process produces an evaluation result, which contains:
- An evaluation report : describes the list of generated files and handled models.
- A debug hierarchy : describes each evaluated rule and script.
This interface is not intended to be implemented by clients.
See Also:

MDWorkbench.getEvaluationManager()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`EvaluationResult`	`evaluate(LaunchConfiguration configuration, ProgressMonitor monitor)` Launches an evaluation based on the specified launch configuration.
`EvaluationResult`	`evaluate(LaunchConfiguration configuration, ProgressMonitor monitor, Map<String,?> options)` Launches an evaluation based on the specified launch configuration and options.
`EvaluationResult`	`evaluate(Project project, Evaluable evaluable, ProgressMonitor monitor)` Launches an evaluation based on the specified project.
`EvaluationResult`	`evaluate(Project project, Evaluable evaluable, ProgressMonitor monitor, Map<String,?> options)` Launches an evaluation based on the specified project and options.
`ContentWriter`	`getContentWriter()` Returns the registered content writer, used to write on disk a text template output.
`DebugHierarchy`	`loadDebugHierarchy(File file)` Loads the specified debug hierarchy.
`LaunchConfiguration`	`loadLaunchConfiguration(File file)` Loads the specified launch configuration.
`Project`	`loadProject(File file)` Loads the specified project.
`Report`	`loadReport(File file)` Loads the specified evaluation report.
`void`	`setContentWriter(ContentWriter writer)` Registers a content writer, used to write on disk a text template output.

- Method Detail
  - loadProject
```
Project loadProject(File file)
             throws CoreException
```
    Loads the specified project.
    
    Parameters:
    
    file - the file containing a project definition.
    
    Returns:
    
    the loaded project.
    
    Throws:
    
    CoreException - if the file could not be read or if the project contains errors.
  - loadReport
```
Report loadReport(File file)
           throws CoreException
```
    Loads the specified evaluation report.
    
    Parameters:
    
    file - the file containing a report definition.
    
    Returns:
    
    the loaded report.
    
    Throws:
    
    CoreException - if the file could not be read.
  - loadLaunchConfiguration
```
LaunchConfiguration loadLaunchConfiguration(File file)
                                     throws CoreException
```
    Loads the specified launch configuration.
    
    Parameters:
    
    file - the file containing a launch configuration.
    
    Returns:
    
    the loaded report.
    
    Throws:
    
    CoreException - if the file could not be read.
  - loadDebugHierarchy
```
DebugHierarchy loadDebugHierarchy(File file)
                           throws CoreException
```
    Loads the specified debug hierarchy.
    
    Parameters:
    
    file - the file containing a debug hierarchy.
    
    Returns:
    
    the loaded debug hierarchy.
    
    Throws:
    
    CoreException - if the file could not be read.
  - evaluate
```
EvaluationResult evaluate(LaunchConfiguration configuration,
                          ProgressMonitor monitor)
                   throws CoreException
```
    Launches an evaluation based on the specified launch configuration. First the project referenced in the configuration is loaded and then the evaluation process of the referenced text template or main rule is started.
    This is a long running operation that can be monitored through the monitor parameter. A progress monitor may be used to report progress information and to interrupt the evaluation process.
    
    Parameters:
    
    configuration - the configuration which describes the launch parameters.
    
    monitor - the progress monitor used to report progress information and check for cancelation, maybe null.
    
    Returns:
    
    an evaluation result, containing a report and a debug hierarchy.
    
    Throws:
    
    CoreException - if the evaluation fails.
  - evaluate
```
EvaluationResult evaluate(LaunchConfiguration configuration,
                          ProgressMonitor monitor,
                          Map<String,?> options)
                   throws CoreException
```
    Launches an evaluation based on the specified launch configuration and options. First the project referenced in the configuration is loaded and then the evaluation process of the referenced text template or main rule is started.
    This is a long running operation that can be monitored through the monitor parameter. A progress monitor may be used to report progress information and to interrupt the evaluation process.
    
    The options parameter enables to provide settings to the underlying evaluation:
    - All provided options are then available during the evaluation using EvaluationContext.getProperty(name).
    - A Logger instance can be set using a "com.sodius.mdw.core.util.log.Logger" key. If absent, the logger used for evaluation will be retrieved using MDWorkbench.getConfiguration().getLogger()
    Parameters:
    
    configuration - the configuration which describes the launch parameters.
    
    monitor - the progress monitor used to report progress information and check for cancelation, may be null.
    
    options - properties to configure the evaluation process (can be null).
    
    Returns:
    
    an evaluation result, containing a report and a debug hierarchy.
    
    Throws:
    
    CoreException - if the evaluation fails.
    
    Since:
    
    3.5.11
  - evaluate
```
EvaluationResult evaluate(Project project,
                          Evaluable evaluable,
                          ProgressMonitor monitor)
                   throws CoreException
```
    Launches an evaluation based on the specified project. The Evaluable implementation has the full control on what is to be evaluated.
    This is a long running operation that can be monitored through the monitor parameter. A progress monitor may be used to report progress information and to interrupt the evaluation process.
    
    Parameters:
    
    project - the project which describes the available templates and scripts.
    
    evaluable - the object whose evaluate method is called.
    
    monitor - the progress monitor used to report progress information and check for cancelation, maybe null.
    
    Returns:
    
    an evaluation result, containing a report and a debug hierarchy.
    
    Throws:
    
    CoreException - if the evaluation fails.
  - evaluate
```
EvaluationResult evaluate(Project project,
                          Evaluable evaluable,
                          ProgressMonitor monitor,
                          Map<String,?> options)
                   throws CoreException
```
    Launches an evaluation based on the specified project and options. The Evaluable implementation has the full control on what is to be evaluated.
    This is a long running operation that can be monitored through the monitor parameter. A progress monitor may be used to report progress information and to interrupt the evaluation process.
    
    The options parameter enables to provide settings to the underlying evaluation:
    - All provided options are then available during the evaluation using EvaluationContext.getProperty(name).
    - A Logger instance can be set using a "com.sodius.mdw.core.util.log.Logger" key. If absent, the logger used for evaluation will be retrieved using MDWorkbench.getConfiguration().getLogger()
    Parameters:
    
    project - the project which describes the available templates and scripts.
    
    evaluable - the object whose evaluate method is called.
    
    monitor - the progress monitor used to report progress information and check for cancelation, may be null.
    
    options - properties to configure the evaluation process (can be null).
    
    Returns:
    
    an evaluation result, containing a report and a debug hierarchy.
    
    Throws:
    
    CoreException - if the evaluation fails.
    
    Since:
    
    3.5.11
  - getContentWriter
```
ContentWriter getContentWriter()
```
    Returns the registered content writer, used to write on disk a text template output.
    
    Returns:
    
    the content writer
  - setContentWriter
```
void setContentWriter(ContentWriter writer)
```
    Registers a content writer, used to write on disk a text template output.
    
    Parameters:
    
    writer - the new content writer to use.

Interface EvaluationManager

Method Summary

Method Detail

loadProject

loadReport

loadLaunchConfiguration

loadDebugHierarchy

evaluate

evaluate

evaluate

evaluate

getContentWriter

setContentWriter