org.eclipse.actf.validation.events
Class ReportEvent

java.lang.Object
  extended by java.util.EventObject
      extended by org.eclipse.actf.validation.events.ReportEvent
All Implemented Interfaces:
Serializable

public class ReportEvent
extends EventObject

used to capture validation report records and creation contexts

Author:
Mike Squillace
See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
ReportEvent(Object source)
          create a new report event
 
Method Summary
 void clear()
          clear the contents of the queues
 CreationContext[] getCreationContexts()
          get the most recently fetched creation contexts.
 String getReportID()
          get the report ID of the current report.
 ValidationReportRecord[] getReportRecords()
          get the most recently fetched set of report records.
 void queueCreationContexts(CreationContext[] contexts)
          add creation contexts to the contexts queue.
 void queueReportRecords(ValidationReportRecord[] records)
          add report records to the reports queue.
 void setReportID(String id)
          set the report ID.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ReportEvent

public ReportEvent(Object source)
create a new report event

Parameters:
source - source of event
Method Detail

getReportRecords

public ValidationReportRecord[] getReportRecords()
get the most recently fetched set of report records. Note that the most recently fetched report is not necessarily the most recently generated report.

Returns:
records from most recently fetched report or null if no report records are available

getCreationContexts

public CreationContext[] getCreationContexts()
get the most recently fetched creation contexts. Note that the most recently fetched contexts are not necessarily the most recently generated contexts.

Returns:
most recently fetched contexts or null if no creation contexts are available

queueReportRecords

public void queueReportRecords(ValidationReportRecord[] records)
add report records to the reports queue. This method, although public, is used by the resource server only.

Parameters:
records -

queueCreationContexts

public void queueCreationContexts(CreationContext[] contexts)
add creation contexts to the contexts queue. This method, although public, is used by the resource server only.

Parameters:
contexts -

setReportID

public void setReportID(String id)
set the report ID. This method should only be called by servers.

Parameters:
id -

getReportID

public String getReportID()
get the report ID of the current report. This id will be valid once a REPORT_STARTED event has been fired.

Returns:
report ID

clear

public void clear()
clear the contents of the queues