Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.ui.service.report
Interface ReportService

All Known Implementing Classes:
ReportServiceImpl

public interface ReportService

Report service interface

Since:
2.2
Author:
Simon Templer
Partner:
01 / Fraunhofer Institute for Computer Graphics Research

Method Summary
<M extends Message,R extends Report<M>>
void
addReport(R report)
          Adds a report
 void addReportListener(ReportListener<?,?> listener)
          Adds a report listener
 void deleteAllReports()
          Deletes all reports.
 Collection<ReportSession> getAllSessions()
          Get all saved sessions.
 com.google.common.collect.Multimap<Class<? extends Report<?>>,Report<?>> getCurrentReports()
          Get all current reports.
 long getCurrentSessionDescription()
          Get the current session description.
 com.google.common.collect.Multimap<Class<? extends Report<?>>,Report<?>> getReports(Class<? extends Message> messageType)
          Get all reports matching the given message type
 void loadReport(File file)
          Load a specific report log file.
 void loadReportsOnStartup()
          Try to reload previous saved reports and their session at program startup.
 void removeReportListener(ReportListener<?,?> listener)
          Removes a report listener
 boolean saveCurrentReports(File file)
          Saves all reports from ReportService to a specific file.
 void saveReportsOnShutdown()
          Saves all reports with there corresponding session on program shutdown.
 void updateCurrentSessionDescription()
          Update the session description.
 

Method Detail

addReport

<M extends Message,R extends Report<M>> void addReport(R report)
Adds a report

Type Parameters:
M - the message type
R - the report type
Parameters:
report - the report to add

addReportListener

void addReportListener(ReportListener<?,?> listener)
Adds a report listener

Parameters:
listener - the report listener to add

removeReportListener

void removeReportListener(ReportListener<?,?> listener)
Removes a report listener

Parameters:
listener - the report listener to remove

getReports

com.google.common.collect.Multimap<Class<? extends Report<?>>,Report<?>> getReports(Class<? extends Message> messageType)
Get all reports matching the given message type

Parameters:
messageType - the message type
Returns:
report types mapped to reports

getCurrentReports

com.google.common.collect.Multimap<Class<? extends Report<?>>,Report<?>> getCurrentReports()
Get all current reports.

Returns:
all reports

deleteAllReports

void deleteAllReports()
Deletes all reports.


saveCurrentReports

boolean saveCurrentReports(File file)
                           throws IOException
Saves all reports from ReportService to a specific file.

Parameters:
file - the file to save
Returns:
true on success
Throws:
IOException - an exception if IO fails

getAllSessions

Collection<ReportSession> getAllSessions()
Get all saved sessions.

Returns:
all sessions

loadReportsOnStartup

void loadReportsOnStartup()
Try to reload previous saved reports and their session at program startup.


saveReportsOnShutdown

void saveReportsOnShutdown()
Saves all reports with there corresponding session on program shutdown.


loadReport

void loadReport(File file)
                throws org.eclipse.jface.bindings.keys.ParseException
Load a specific report log file.

Parameters:
file - report log file
Throws:
org.eclipse.jface.bindings.keys.ParseException - if a parse error occurred

getCurrentSessionDescription

long getCurrentSessionDescription()
Get the current session description.

Returns:
session description

updateCurrentSessionDescription

void updateCurrentSessionDescription()
Update the session description.


Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d