net.datenwerke.eximport.ex

Class ExporterImpl<C extends ExportItemConfig<?>>

java.lang.Object

net.datenwerke.eximport.ex.ExporterImpl<C>

Type Parameters:

C -

All Implemented Interfaces:

Exporter

Direct Known Subclasses:

GenericEntityExporter, TreeNodeExporter

public abstract class ExporterImpl<C extends ExportItemConfig<?>>
extends java.lang.Object
implements Exporter

Provides a base implementation for simple exporters.

Constructor Summary

Constructors

Constructor and Description
ExporterImpl()

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	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 supervisor, EnclosedObjectConfig config) Exports an enclosed entity.
ExportItemConfig<?>	getConfigFor(java.lang.Object value)
java.lang.String	getDisplayNameFor(ExportedItem exportedItem) Generates a name for the ExportedItem to display to the user
boolean	hasConfigFor(java.lang.Object value)
void	setReflectionServices(ReflectionService reflectionServices)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.datenwerke.eximport.ex.Exporter

consumes, generateExportConfig, getExporterId

Constructor Detail

ExporterImpl

public ExporterImpl()

Method Detail

setReflectionServices

public void setReflectionServices(ReflectionService reflectionServices)

consumes

public boolean consumes(ExportItemConfig<?> config)

Description copied from interface: Exporter

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

Specified by:

consumes in interface Exporter

configure

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

Description copied from interface: Exporter

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

Exporter should throw Exception in case the configuration is invalid.

Specified by:

configure in interface Exporter

export

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

Description copied from interface: Exporter

Starts the export of the given configuration.

Specified by:

export in interface Exporter

Throws:

javax.xml.stream.XMLStreamException

consumesEnclosedObject

public boolean consumesEnclosedObject(EnclosedObjectConfig config)

Description copied from interface: Exporter

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

Specified by:

consumesEnclosedObject in interface Exporter

exportEnclosed

public void exportEnclosed(ExportSupervisor supervisor,
                           EnclosedObjectConfig config)

Description copied from interface: Exporter

Exports an enclosed entity.

Specified by:

exportEnclosed in interface Exporter

addReferences

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

Specified by:

addReferences in interface Exporter

addEnclosed

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

Specified by:

addEnclosed in interface Exporter

addReferences

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

Specified by:

addReferences in interface Exporter

addEnclosed

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

Specified by:

addEnclosed in interface Exporter

hasConfigFor

public boolean hasConfigFor(java.lang.Object value)

Specified by:

hasConfigFor in interface Exporter

getConfigFor

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

Specified by:

getConfigFor in interface Exporter

getDisplayNameFor

public java.lang.String getDisplayNameFor(ExportedItem exportedItem)

Description copied from interface: Exporter

Generates a name for the ExportedItem to display to the user

Specified by:

getDisplayNameFor in interface Exporter