Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.util.evfparser
Interface IQSYSEventsFileProcessor

All Known Implementing Classes:
QSYSEventsFileExpansionProcessor, QSYSEventsFileExpansionProcessorCore

public interface IQSYSEventsFileProcessor

This interface defines a backbone for processing Events File Records.
As the Events File Format gets more complex and more used, the parsing logic should be seperated from the processing logic. A different processor could potentially be associated with Events Files generated for different purposes.
For instance, an SQL compile might need a different processor to make use of the Expansion record.


Method Summary
 boolean doPostProcessing()
          After parsing all records in the Events File, this method will be called to process the records.
 boolean doPreProcessing()
          Before parsing all records in the Events File, this method will be called to allow the processor to perform initialization.
 LinkedList getAllErrors()
          After all records in the Events File are processed, this method is called to return all the errors from all the processor blocks (QSYSEventsFileProcessorBlock) of the Events File.
 Set getAllFileIDRecords()
          Return all file names.
 void processErrorRecord(QSYSEventsFileErrorInformationRecord record)
          Processes an Error record object.
 void processExpansionRecord(QSYSEventsFileExpansionRecord record)
          Processes an Expansion record object.
 void processFeedbackCodeRecord(QSYSEventsFileFeedbackCodeRecord record)
          Processes a Feedback Code record object.
 void processFileEndRecord(QSYSEventsFileFileEndRecord record)
          Processes a File End record object.
 void processFileIDRecord(QSYSEventsFileFileIDRecord record)
          Processes a File ID record object.
 void processMapDefineRecord(QSYSEventsFileMapDefineRecord record)
          Processes a Map Define record object.
 void processMapEndRecord(QSYSEventsFileMapEndRecord record)
          Processes a Map End record object.
 void processMapStartRecord(QSYSEventsFileMapStartRecord record)
          Processes a Map Start record object.
 void processProcessorRecord(QSYSEventsFileProcessorRecord record)
          Processes a Processor record object.
 void processProgramRecord(QSYSEventsFileProgramRecord record)
          Processes a Program record object.
 void processTimestampRecord(QSYSEventsFileTimestampRecord record)
          Processes a Timestamp record object.
 

Method Detail

processFileIDRecord

void processFileIDRecord(QSYSEventsFileFileIDRecord record)
                         throws SecondLevelHelpException
Processes a File ID record object.

Parameters:
record -
Throws:
SecondLevelHelpException

processFileEndRecord

void processFileEndRecord(QSYSEventsFileFileEndRecord record)
                          throws SecondLevelHelpException
Processes a File End record object.

Parameters:
record -
Throws:
SecondLevelHelpException

processProcessorRecord

void processProcessorRecord(QSYSEventsFileProcessorRecord record)
                            throws SecondLevelHelpException
Processes a Processor record object.

Parameters:
record -
Throws:
SecondLevelHelpException

processTimestampRecord

void processTimestampRecord(QSYSEventsFileTimestampRecord record)
Processes a Timestamp record object.

Parameters:
record -

processErrorRecord

void processErrorRecord(QSYSEventsFileErrorInformationRecord record)
Processes an Error record object.

Parameters:
record -

processProgramRecord

void processProgramRecord(QSYSEventsFileProgramRecord record)
Processes a Program record object.

Parameters:
record -

processFeedbackCodeRecord

void processFeedbackCodeRecord(QSYSEventsFileFeedbackCodeRecord record)
Processes a Feedback Code record object.

Parameters:
record -

processMapDefineRecord

void processMapDefineRecord(QSYSEventsFileMapDefineRecord record)
Processes a Map Define record object.

Parameters:
record -

processMapStartRecord

void processMapStartRecord(QSYSEventsFileMapStartRecord record)
Processes a Map Start record object.

Parameters:
record -

processMapEndRecord

void processMapEndRecord(QSYSEventsFileMapEndRecord record)
Processes a Map End record object.

Parameters:
record -

processExpansionRecord

void processExpansionRecord(QSYSEventsFileExpansionRecord record)
Processes an Expansion record object.

Parameters:
record -

doPostProcessing

boolean doPostProcessing()
                         throws SecondLevelHelpException
After parsing all records in the Events File, this method will be called to process the records.

Returns:
true if post-processing was succesful. false otherwise.
Throws:
SecondLevelHelpException

doPreProcessing

boolean doPreProcessing()
Before parsing all records in the Events File, this method will be called to allow the processor to perform initialization.

Returns:
true if pre-processing was succesful. false otherwise.

getAllErrors

LinkedList getAllErrors()
After all records in the Events File are processed, this method is called to return all the errors from all the processor blocks (QSYSEventsFileProcessorBlock) of the Events File. Since each QSYSEventsFileProcessorBlock contains a LinkedList of errors, the result will be returned as a LinkedList of those linked lists. This method is called by EventsFileParser.printEventFileErrors(), which in turn is called by the JUnit test for event file processing.

Returns:
a list of lists of all parsed errors from all processor blocks of the Events File (one list for each processor block).

getAllFileIDRecords

Set getAllFileIDRecords()
Return all file names.


Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.