org.rhq.enterprise.server.sync.exporters
Interface Exporter<Entity,ExportedType>

Type Parameters:

Entity - the type of entities exported by the exporter

ExportedType - the type that represents the entity in the export

All Known Implementing Classes:

MetricTemplateExporter, SystemSettingsExporter

public interface Exporter<Entity,ExportedType>

This is the interface a subsystem export must implement.

Author:

Lukas Krejci

Method Summary

ExportingIterator<ExportedType>	getExportingIterator() Creates an iterator that is able to traverse the exported data and serialize them one by one.
String	getNotes() This method can return some notes that the exporter gathered during exporting the entities that are not specific to the individual entities.

Method Detail

getExportingIterator

ExportingIterator<ExportedType> getExportingIterator()

Creates an iterator that is able to traverse the exported data and serialize them one by one.

The implementation is free to preload the exported entities or to somehow load them one by one as the callers request by calling Iterator.next().

Returns:

getNotes

String getNotes()

This method can return some notes that the exporter gathered during exporting the entities that are not specific to the individual entities.

This method is only called after the export iterator reached the end.