Jadex 0.941

jadex.model
Class Report

java.lang.Object
  extended byjadex.model.Report

public class Report
extends Object

A report contains information about errors in the model.


Constructor Summary
Report(IMElement element)
          Create a report object.
 
Method Summary
 void addDocument(String id, String doc)
          Add an external document.
 void addEntry(IMElement element, String message)
          Add an entry to the report.
 IMElement[] getBeliefbaseErrors()
          Get beliefs, belief sets, references, and initial elements which have errors, or contain elements with errors.
 Map getDocuments()
          Get the external documents.
 IMElement[] getElementErrors(IMElement ancestor)
          Get all elements which have errors and are contained in the given element.
 IMElement[] getElements()
          Get all invalid elements.
 int getErrorCount()
          Get the total number of errors.
 IMElement[] getEventbaseErrors()
          Get events, references, and initial elements which have errors, or contain elements with errors.
 IMElement[] getGoalbaseErrors()
          Get goals, references, and initial elements which have errors, or contain elements with errors.
 String[] getMessages(IMElement element)
          Get the messages for a given element.
 IMElement[] getOtherErrors()
          Get other errors, not in belief goal and plan base.
 IMElement[] getPlanbaseErrors()
          Get plans, and initial elements which have errors, or contain elements with errors.
 boolean isEmpty()
          Check if this report is empty (i.e. the model is valid).
 String toHTMLString()
          Generate an html representation of the report.
 String toString()
          Generate a string representation of the report.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Report

public Report(IMElement element)
Create a report object.

Method Detail

isEmpty

public boolean isEmpty()
Check if this report is empty (i.e. the model is valid).


addEntry

public void addEntry(IMElement element,
                     String message)
Add an entry to the report.

Parameters:
element - The element to which the entry applies.
message - The problem description.

getElements

public IMElement[] getElements()
Get all invalid elements.


getMessages

public String[] getMessages(IMElement element)
Get the messages for a given element.


toString

public String toString()
Generate a string representation of the report.


toHTMLString

public String toHTMLString()
Generate an html representation of the report.


getBeliefbaseErrors

public IMElement[] getBeliefbaseErrors()
Get beliefs, belief sets, references, and initial elements which have errors, or contain elements with errors.


getGoalbaseErrors

public IMElement[] getGoalbaseErrors()
Get goals, references, and initial elements which have errors, or contain elements with errors.


getPlanbaseErrors

public IMElement[] getPlanbaseErrors()
Get plans, and initial elements which have errors, or contain elements with errors.


getEventbaseErrors

public IMElement[] getEventbaseErrors()
Get events, references, and initial elements which have errors, or contain elements with errors.


getOtherErrors

public IMElement[] getOtherErrors()
Get other errors, not in belief goal and plan base.


getElementErrors

public IMElement[] getElementErrors(IMElement ancestor)
Get all elements which have errors and are contained in the given element.


addDocument

public void addDocument(String id,
                        String doc)
Add an external document.

Parameters:
id - The document id as used in anchor tags.
doc - The html text.

getDocuments

public Map getDocuments()
Get the external documents.


getErrorCount

public int getErrorCount()
Get the total number of errors.


Jadex 0.941

Submit a bug or feature
For further API reference and developer documentation, see the Jadex User Guide and the Jadex Tutorial. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, and working code examples.

Copyright (C) 2002-2005 Lars Braubach, Alexander Pokahr, Andrzej Walczak - University of Hamburg. Use is subject to license terms.