com.ibm.etools.systems.application.collector
Interface ICollector

All Known Implementing Classes:

AbstractCollector

public interface ICollector

Required Interface for populating the Application Model. Resource Collectors must implement this interface in order to populate the Application Model.

Method Summary

List	populate(ApplicationModel model, CollectorResource[] resources, IProgressMonitor monitor) Given an Application Model build its content.
List	populateFinal(ApplicationModel model, CollectorResource[] resources, IProgressMonitor monitor) Given an Application Model finalize its content.

Method Detail

populate

List populate(ApplicationModel model,
              CollectorResource[] resources,
              IProgressMonitor monitor)
              throws InterruptedException

Given an Application Model build its content. Application Model can be populated in two phases. This method is the first phase of the model build. All registered Collectors are called to build the model during first phase. This phase is intended to build up the initial Application Model.

Parameters:

model - The model instance to be build

resources - The array of resources from which to populate the model

monitor - A progress monitor to report progress. Subclassess should only set the subtask on the monitor and should periodically check for cancellation

Returns:

A list of messages generated during model build

Throws:

InterruptedException

populateFinal

List populateFinal(ApplicationModel model,
                   CollectorResource[] resources,
                   IProgressMonitor monitor)
                   throws InterruptedException

Given an Application Model finalize its content. Application Model can be populated in two phases. This method is the second phase of the model build which starts after the first phase is completed for all registered collectors. All registered Collectors are called to finalize the model during second phase. This phase is optional and is intended to resolve any Model relationships that were not feasible during the first phase of Application Model build. For example: In the first phase, each collector populates artifacts and relationships between artifacts it created. In the second phase, the collector populates relationships between artifacts it created and artifacts created by other collectors.

Parameters:

model - The model instance to be build

resources - The array of resources from which to populate the model

monitor - A progress monitor to report progress. Subclassess should only set the subtask on the monitor and should periodically check for cancellation

Returns:

A list of messages generated during the second phase of model build

Throws:

InterruptedException