org.modelio.api.module.report

Class Report

java.lang.Object

org.modelio.api.module.report.Report

public class Report
extends java.lang.Object

A Report is a sequence of ReportEntry records. Beside storing the recorded ReportEntry instances, this class mainly provides several convenience methods to add errors, warnings tips and infos to the report. See @link addError(int, String, MObject...) and similar methods.

Note about the use of varargs for the related MObject objects:

 // To add objects obj1, obj2 and obj3, simply pass the objects to the addXXX() call
 addError(1001, "My formatted message with three related objects", obj1, obj2 obj3);
 
 // For 'no objects' , do not pass 'null' but rather pass nothing
 addError(1001, "My formatted message with no related objects");
 

Since:

4.1

Constructor Summary

Constructors

Constructor and Description
Report(java.lang.String title)

Method Summary

Modifier and Type	Method and Description
void	addError(int code, java.lang.String message, MObject... mObjects) Adds an ERROR message to the Report.
void	addError(int code, java.lang.String category, java.lang.String message, MObject... mObjects) Adds an ERROR message to the Report.
void	addError(int code, java.lang.String category, java.lang.String helpUrl, java.lang.String message, MObject... mObjects) Adds an ERROR message to the Report.
void	addInfo(java.lang.String message) Adds an INFO message to the Report.
void	addTip(int code, java.lang.String message, MObject... mObjects) Adds an TIP message to the Report.
void	addTip(int code, java.lang.String category, java.lang.String message, MObject... mObjects) Adds an TIP message to the Report.
void	addTip(int code, java.lang.String category, java.lang.String helpUrl, java.lang.String message, MObject... mObjects) Adds an TIP message to the Report.
void	addWarning(int code, java.lang.String message, MObject... mObjects) Adds an WARNING message to the Report.
void	addWarning(int code, java.lang.String category, java.lang.String message, MObject... mObjects) Adds an WARNING message to the Report.
void	addWarning(int code, java.lang.String category, java.lang.String helpUrl, java.lang.String message, MObject... mObjects) Adds an WARNING message to the Report.
java.util.List<ReportEntry>	getEntries()
java.lang.String	getTitle()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Report

public Report(java.lang.String title)

Method Detail

addError

public void addError(int code,
                     java.lang.String message,
                     MObject... mObjects)

Adds an ERROR message to the Report. The added error message has no category and no help topic.

Parameters:

code - - the message code (mandatory)

message - - the formatted message, with I18n and parameter substitution already done.

mObjects - - the model elements related to this entry. By convention the first one is the 'main' element where the error occured or was detected.

addWarning

public void addWarning(int code,
                       java.lang.String message,
                       MObject... mObjects)

Adds an WARNING message to the Report. The added warning message has no category and no help topic.

Parameters:

code - - the message code (mandatory)

message - - the formatted message, with I18n and parameter substitution already done.

mObjects - - the model elements related to this entry. By convention the first one is the 'main' element where the warning occured or was detected.

addInfo

public void addInfo(java.lang.String message)

Adds an INFO message to the Report.

Parameters:

message - - the formatted message, with I18n and parameter substitution already done.

getEntries

public java.util.List<ReportEntry> getEntries()

getTitle

public java.lang.String getTitle()

addTip

public void addTip(int code,
                   java.lang.String message,
                   MObject... mObjects)

Adds an TIP message to the Report. The added tip message has no category and no help topic.

Parameters:

code - - the message code (mandatory)

message - - the formatted message, with I18n and parameter substitution already done.

mObjects - - the model elements related to this entry. By convention the first one is the 'main' element where the tip was identified.

addError

public void addError(int code,
                     java.lang.String category,
                     java.lang.String message,
                     MObject... mObjects)

Adds an ERROR message to the Report. The added error message has no help topic.

Parameters:

code - - the message code (mandatory)

category - - the message category (may be null)

message - - the formatted message, with I18n and parameter substitution already done.

mObjects - - the model elements related to this entry. By convention the first one is the 'main' element where the error occured or was detected.

addError

public void addError(int code,
                     java.lang.String category,
                     java.lang.String helpUrl,
                     java.lang.String message,
                     MObject... mObjects)

Adds an ERROR message to the Report.

Parameters:

code - - the message code (mandatory)

category - - the message category (may be null)

helpUrl - - the message help topic in the Modelio Help (may be null)

message - - the formatted message, with I18n and parameter substitution already done.

mObjects - - the model elements related to this entry. By convention the first one is the 'main' element where the error occured or was detected.

addWarning

public void addWarning(int code,
                       java.lang.String category,
                       java.lang.String message,
                       MObject... mObjects)

Adds an WARNING message to the Report. The added warning message has no help topic.

Parameters:

code - - the message code (mandatory)

category - - the message category (may be null)

message - - the formatted message, with I18n and parameter substitution already done.

mObjects - - the model elements related to this entry. By convention the first one is the 'main' element where the warning occured or was detected.

addWarning

public void addWarning(int code,
                       java.lang.String category,
                       java.lang.String helpUrl,
                       java.lang.String message,
                       MObject... mObjects)

Adds an WARNING message to the Report.

Parameters:

code - - the message code (mandatory)

category - - the message category (may be null)

helpUrl - - the message help topic in the Modelio Help (may be null)

message - - the formatted message, with I18n and parameter substitution already done.

mObjects - - the model elements related to this entry. By convention the first one is the 'main' element where the warning occured or was detected.

addTip

public void addTip(int code,
                   java.lang.String category,
                   java.lang.String message,
                   MObject... mObjects)

Adds an TIP message to the Report. The added tip message has no help topic.

Parameters:

code - - the message code (mandatory)

category - - the message category (may be null)

message - - the formatted message, with I18n and parameter substitution already done.

mObjects - - the model elements related to this entry. By convention the first one is the 'main' element where the tip was identified.

addTip

public void addTip(int code,
                   java.lang.String category,
                   java.lang.String helpUrl,
                   java.lang.String message,
                   MObject... mObjects)

Adds an TIP message to the Report.

Parameters:

code - - the message code (mandatory)

category - - the message category (may be null)

helpUrl - - the message help topic in the Modelio Help (may be null)

message - - the formatted message, with I18n and parameter substitution already done.

mObjects - - the model elements related to this entry. By convention the first one is the 'main' element where the tip was identified.