corpus-services  1.0
de.uni_hamburg.corpora.ReportItem Class Reference
+ Collaboration diagram for de.uni_hamburg.corpora.ReportItem:

Classes

enum  Severity
 

Public Member Functions

 ReportItem ()
 
 ReportItem (Severity s, String what)
 
 ReportItem (Severity s, Throwable e, String what)
 
 ReportItem (Severity s, Throwable e, String filename, String what)
 
 ReportItem (Severity s, String filename, String what, String function)
 
 ReportItem (Severity s, SAXParseException saxpe, String what)
 
 ReportItem (Severity s, String filename, String what, String function, String howto)
 
Severity getSeverity ()
 
boolean isGood ()
 
boolean isBad ()
 
boolean isSevere ()
 
boolean isFix ()
 
String getLocation ()
 
String getWhat ()
 
String getHowto ()
 
String getFunction ()
 
String getLocalisedMessage ()
 
String getSummary ()
 
String toString ()
 
String getStackTrace ()
 

Static Public Member Functions

static String generatePlainText (Collection< ReportItem > errors, boolean verbose)
 
static String generateSummary (Collection< ReportItem > errors)
 
static String generateHTML (Collection< ReportItem > errors)
 
static String generateDataTableHTML (Collection< ReportItem > errors, String summarylines)
 

Detailed Description

Error message class is meant to facilitate creating user friendly error messages in HZSK validators. It kind of forces the programmer to at least rephrase an exception to two messages describing the problem and suggested solution. Can be used without exception as well.

Definition at line 25 of file ReportItem.java.

Constructor & Destructor Documentation

de.uni_hamburg.corpora.ReportItem.ReportItem ( )

Default constructor should only be used when nothing at all is known of the error.

Definition at line 78 of file ReportItem.java.

de.uni_hamburg.corpora.ReportItem.ReportItem ( Severity  s,
String  what 
)

Definition at line 85 of file ReportItem.java.

de.uni_hamburg.corpora.ReportItem.ReportItem ( Severity  s,
Throwable  e,
String  what 
)

Definition at line 91 of file ReportItem.java.

de.uni_hamburg.corpora.ReportItem.ReportItem ( Severity  s,
Throwable  e,
String  filename,
String  what 
)

Definition at line 98 of file ReportItem.java.

de.uni_hamburg.corpora.ReportItem.ReportItem ( Severity  s,
String  filename,
String  what,
String  function 
)

Definition at line 106 of file ReportItem.java.

de.uni_hamburg.corpora.ReportItem.ReportItem ( Severity  s,
SAXParseException  saxpe,
String  what 
)

Errors found by XML validation errors should always include a SAXParseException. This can be used to extract file location informations in most situations.

Definition at line 118 of file ReportItem.java.

de.uni_hamburg.corpora.ReportItem.ReportItem ( Severity  s,
String  filename,
String  what,
String  function,
String  howto 
)

Generic file parsing error that can not be pointed to a line location can be constructed from filename and descriptions.

Definition at line 134 of file ReportItem.java.

Member Function Documentation

static String de.uni_hamburg.corpora.ReportItem.generateDataTableHTML ( Collection< ReportItem errors,
String  summarylines 
)
static

Generate a simple HTML snippet version of validation errors. Includes quite ugly table of all the reports with a java script to hide errors based on severity.

Definition at line 502 of file ReportItem.java.

static String de.uni_hamburg.corpora.ReportItem.generateHTML ( Collection< ReportItem errors)
static

Generate a simple HTML snippet version of validation errors. Includes quite ugly table of all the reports with a java script to hide errors based on severity.

Definition at line 408 of file ReportItem.java.

static String de.uni_hamburg.corpora.ReportItem.generatePlainText ( Collection< ReportItem errors,
boolean  verbose 
)
static

Generate a plain text report from validation errors for end user. This can be presented on command-line.

Parameters
verboseif true, generates detailed report of all errors, otherwise returns a summary and critical errors.

Definition at line 321 of file ReportItem.java.

static String de.uni_hamburg.corpora.ReportItem.generateSummary ( Collection< ReportItem errors)
static

Generate a very short summary of validawtion errors.

Definition at line 371 of file ReportItem.java.

String de.uni_hamburg.corpora.ReportItem.getFunction ( )

A suggested fix to the error.

Definition at line 259 of file ReportItem.java.

String de.uni_hamburg.corpora.ReportItem.getHowto ( )

A suggested fix to the error.

Definition at line 248 of file ReportItem.java.

String de.uni_hamburg.corpora.ReportItem.getLocalisedMessage ( )

a localised message from the excpetion if any.

Definition at line 270 of file ReportItem.java.

String de.uni_hamburg.corpora.ReportItem.getLocation ( )

Location of error in filename:lines.columns format if any.

Definition at line 221 of file ReportItem.java.

Severity de.uni_hamburg.corpora.ReportItem.getSeverity ( )

Severity of the error

Definition at line 146 of file ReportItem.java.

String de.uni_hamburg.corpora.ReportItem.getStackTrace ( )

The stack trace of the exception if any.

Definition at line 302 of file ReportItem.java.

String de.uni_hamburg.corpora.ReportItem.getSummary ( )

A short string about the stuff.

Definition at line 281 of file ReportItem.java.

String de.uni_hamburg.corpora.ReportItem.getWhat ( )

Description of the error.

Definition at line 241 of file ReportItem.java.

boolean de.uni_hamburg.corpora.ReportItem.isBad ( )

whether the stuff should be counted towards bad statistic.

Definition at line 170 of file ReportItem.java.

boolean de.uni_hamburg.corpora.ReportItem.isFix ( )

whether the stuff should be counted towards bad statistic.

Definition at line 204 of file ReportItem.java.

boolean de.uni_hamburg.corpora.ReportItem.isGood ( )

whether the stuff should be counted towards good statistic.

Definition at line 153 of file ReportItem.java.

boolean de.uni_hamburg.corpora.ReportItem.isSevere ( )

whether the stuff should be presented as severe problem.

Definition at line 187 of file ReportItem.java.

String de.uni_hamburg.corpora.ReportItem.toString ( )

A pretty printed string with most informations about the error. Can be super long.

Definition at line 294 of file ReportItem.java.


The documentation for this class was generated from the following file: