net.datenwerke.eximport.ex

Interface Exporter

All Known Implementing Classes:

DashboardManagerExporter, DatasinkManagerExporter, DatasourceManagerExporter, EnclosedEntityExporter, EnclosedObjectExporter, ExporterImpl, FileServerExporter, GenericEntityExporter, GenericRightsExporter, GlobalConstantExporter, ParameterInstanceExporter, RemoteServerManagerExporter, ReportManagerExporter, TeamSpaceExporter, TreeNodeExporter, TsDiskExporter, UserManagerExporter, UserVariableExporter

public interface Exporter

Method Summary

Modifier and Type	Method and Description
java.util.Collection<EnclosedObjectConfig>	addEnclosed(ExportSupervisor exportSupervisor, java.util.Collection<ExportItemConfig<?>> configItems)
java.util.Collection<EnclosedObjectConfig>	addEnclosed(ExportSupervisor exportSupervisor, EnclosedObjectConfig enclosedCon)
java.util.Collection<ExportItemConfig<?>>	addReferences(ExportSupervisor exportSupervisor, java.util.Collection<ExportItemConfig<?>> configItems)
java.util.Collection<ExportItemConfig<?>>	addReferences(ExportSupervisor exportSupervisor, EnclosedObjectConfig enclosedCon)
void	configure(java.util.Collection<ExporterSpecificExportConfig> specificConfigs, java.util.Collection<ExportItemConfig<?>> configItems) Configures the exporter and tells it what items it should export.
boolean	consumes(ExportItemConfig<?> config) Tells the exportservice whether this exporter can handle the given config item.
boolean	consumes(java.lang.Object object)
boolean	consumesEnclosedObject(EnclosedObjectConfig config) Tells the exportservice if this exporter can export the given object.
void	export(ExportSupervisor exportSupervisor) Starts the export of the given configuration.
void	exportEnclosed(ExportSupervisor exportSupervisor, EnclosedObjectConfig config) Exports an enclosed entity.
ExportItemConfig<?>	generateExportConfig(java.lang.Object object) Asks the exporter to generate an export config for the given object.
ExportItemConfig<?>	getConfigFor(java.lang.Object value)
java.lang.String	getDisplayNameFor(ExportedItem exportedItem) Generates a name for the ExportedItem to display to the user
java.lang.String	getExporterId()
boolean	hasConfigFor(java.lang.Object value)

Method Detail

getExporterId

java.lang.String getExporterId()

consumes

boolean consumes(ExportItemConfig<?> config)

Tells the exportservice whether this exporter can handle the given config item.

Parameters:

config -

consumesEnclosedObject

boolean consumesEnclosedObject(EnclosedObjectConfig config)

Tells the exportservice if this exporter can export the given object.

This case occurs if an enclosed entity is encountered and the exporter asks the supervisor for help

export

void export(ExportSupervisor exportSupervisor)
     throws javax.xml.stream.XMLStreamException

Starts the export of the given configuration.

Parameters:

exportSupervisor -

Throws:

javax.xml.stream.XMLStreamException

exportEnclosed

void exportEnclosed(ExportSupervisor exportSupervisor,
                    EnclosedObjectConfig config)
             throws javax.xml.stream.XMLStreamException

Exports an enclosed entity.

Throws:

javax.xml.stream.XMLStreamException

configure

void configure(java.util.Collection<ExporterSpecificExportConfig> specificConfigs,
               java.util.Collection<ExportItemConfig<?>> configItems)

Configures the exporter and tells it what items it should export.

Exporter should throw Exception in case the configuration is invalid.

addReferences

java.util.Collection<ExportItemConfig<?>> addReferences(ExportSupervisor exportSupervisor,
                                                        java.util.Collection<ExportItemConfig<?>> configItems)

addEnclosed

java.util.Collection<EnclosedObjectConfig> addEnclosed(ExportSupervisor exportSupervisor,
                                                       java.util.Collection<ExportItemConfig<?>> configItems)

generateExportConfig

ExportItemConfig<?> generateExportConfig(java.lang.Object object)

Asks the exporter to generate an export config for the given object.

If the exporter does not know the item, it should return null

Parameters:

object -

hasConfigFor

boolean hasConfigFor(java.lang.Object value)

getConfigFor

ExportItemConfig<?> getConfigFor(java.lang.Object value)

addReferences

java.util.Collection<ExportItemConfig<?>> addReferences(ExportSupervisor exportSupervisor,
                                                        EnclosedObjectConfig enclosedCon)

addEnclosed

java.util.Collection<EnclosedObjectConfig> addEnclosed(ExportSupervisor exportSupervisor,
                                                       EnclosedObjectConfig enclosedCon)

getDisplayNameFor

java.lang.String getDisplayNameFor(ExportedItem exportedItem)

Generates a name for the ExportedItem to display to the user

Parameters:

exportedItem -

consumes

boolean consumes(java.lang.Object object)