jadex.bridge

Class AbstractErrorReportBuilder

java.lang.Object

jadex.bridge.AbstractErrorReportBuilder

Direct Known Subclasses:

BDIErrorReportBuilder

public abstract class AbstractErrorReportBuilder
extends Object

Helper class for building error reports.

Constructor Summary

Constructors

Constructor and Description
AbstractErrorReportBuilder(String name, String filename, String[] categories, MultiCollection entries, Map externals) Build the error based on the given entries (if any).

Method Summary

Methods

Modifier and Type	Method and Description
IErrorReport	buildErrorReport() Build the error based on the given entries (if any).
abstract String	getObjectName(Object obj) Get the name of an object.
abstract Object	getPathElementObject(Object element) Get the object of a path element
abstract boolean	isInCategory(Object obj, String category) Test if an object belongs to a category.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractErrorReportBuilder

public AbstractErrorReportBuilder(String name,
                          String filename,
                          String[] categories,
                          MultiCollection entries,
                          Map externals)

Build the error based on the given entries (if any). Entries represent error messages mapped by the path to the xml element (as a tuple of stack elements).

Parameters:

name - The unqualified (model/file) name.

filename - The file name with path (optional).

categories - The element categories.

entries - The parse errors (tuple(stack elements) -> {error messages}).

externals - The external documents for links in html error reports, if any (id -> html text).

Method Detail

buildErrorReport

public IErrorReport buildErrorReport()

Build the error based on the given entries (if any). Entries represent error messages mapped by the path to the xml element (as a tuple of stack elements).

Returns:

The error report.

getPathElementObject

public abstract Object getPathElementObject(Object element)

Get the object of a path element

Parameters:

obj - An item (entry) of a tuple in the multi collection.

Returns:

The object corresponding to the entry.

isInCategory

public abstract boolean isInCategory(Object obj,
                   String category)

Test if an object belongs to a category.

Parameters:

obj - An item (entry) of a tuple in the multi collection.

category - the category name.

Returns:

True, when the object belongs to the category.

getObjectName

public abstract String getObjectName(Object obj)

Get the name of an object.

Parameters:

obj - An object having an error.

Returns:

A human readable name of the object.