com.sodius.mdw.core.eval
Interface EvaluationResult


public interface EvaluationResult

Provides access to the output of an evaluation. This output consist of :

This interface is not intended to be implemented by clients.


Method Summary
 DebugHierarchy getDebugHierarchy()
          Returns the created debug hierarchy, or null if not enabled.
 Report getReport()
          Returns the evaluation report, which details the generated file and handled models.
 boolean isDebugHierarchyEnabled()
          Returns true if a debug hierarchy has been created during the evaluation.
 

Method Detail

getReport

Report getReport()
Returns the evaluation report, which details the generated file and handled models.

Returns:
the evaluation report.

isDebugHierarchyEnabled

boolean isDebugHierarchyEnabled()
Returns true if a debug hierarchy has been created during the evaluation. A debug hierarchy is computed only if requested in the evaluation options.

Returns:
true if a debug hierarchy has been created during the evaluation, false otherwise.
See Also:
EvaluationConfiguration.isDebugHierarchyEnabled()

getDebugHierarchy

DebugHierarchy getDebugHierarchy()
Returns the created debug hierarchy, or null if not enabled.

A debug hierarchy keeps track of every evaluated template, rule and script, for debugging purpose. This lets the developer navigate in the evaluation tree once the evaluation is completed.

A debug hierarchy comes at a considerable cost in both time and space, and should not be requested frivolously. The additional space is not reclaimed until the debug hierarchy and all its nodes become garbage. So it is very important to not retain any of these objects longer than absolutely necessary

Returns:
the created debug hierarchy, or null if not enabled.
See Also:
isDebugHierarchyEnabled()