Package de.julielab.concepts.db.core.spi

Interface DataExporter

All Superinterfaces:

DatabaseConnected, de.julielab.jssf.commons.spi.ExtensionPoint, de.julielab.jssf.commons.spi.ParameterExposing

All Known Implementing Classes:

CypherBoltExporter, CypherFileDBExporter, CypherHttpExporter, DataExporterImpl, JavaClassFileDBExporter, RestExporter

public interface DataExporter
extends de.julielab.jssf.commons.spi.ExtensionPoint, DatabaseConnected, de.julielab.jssf.commons.spi.ParameterExposing

Data exporters read a database, extract specific information and store it at some external location in a specific output format.

Some complexity arises concerning the connection to the database. Ideally, each data exporter can handle all database connections. The core library delivers connections via BOLT or via direct file access to the database. If a connection can not be obtained, a meaningful exception should be thrown from DatabaseConnected.setConnection(HierarchicalConfiguration);

Author:

faessler

Method Summary

Modifier and Type	Method	Description
void	exportData(org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> exportConfig)	Export data from the database to an external location.

Methods inherited from interface de.julielab.concepts.db.core.spi.DatabaseConnected

setConnection

Methods inherited from interface de.julielab.jssf.commons.spi.ExtensionPoint

getName, hasName

Methods inherited from interface de.julielab.jssf.commons.spi.ParameterExposing

exposeParameters

Method Detail

exportData

void exportData(org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> exportConfig)
         throws ConceptDatabaseConnectionException,
                DataExportException,
                IncompatibleActionHandlerConnectionException

Export data from the database to an external location.

Parameters:

exportConfig - Export subconfiguration.

Throws:

ConceptDatabaseConnectionException - When this exporter cannot connect to the database.

DataExportException - When the implementing exporter can not serve the provided export configuration.

IncompatibleActionHandlerConnectionException