Package de.julielab.concepts.db.core

Class RestExporter

java.lang.Object

de.julielab.concepts.db.core.FunctionCallBase

de.julielab.concepts.db.core.RestCallBase

de.julielab.concepts.db.core.RestExporter

All Implemented Interfaces:

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

public class RestExporter
extends RestCallBase
implements DataExporter

Nested Class Summary

Nested classes/interfaces inherited from class de.julielab.concepts.db.core.FunctionCallBase

FunctionCallBase.Parameter

Constructor Summary

Constructors

Constructor	Description
RestExporter()

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.
void	exposeParameters(String basePath, org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> template)
String	getName()
void	setConnection(org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> connectionConfiguration)	Requires the implementing service provider to check if the given connection is supported and, if so, to use it for later method calls.

Methods inherited from class de.julielab.concepts.db.core.RestCallBase

callNeo4jRestEndpoint

Methods inherited from class de.julielab.concepts.db.core.FunctionCallBase

parseParameters

Methods inherited from class java.lang.Object

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

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

hasName

Constructor Detail

RestExporter

public RestExporter()

Method Detail

exportData

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

Description copied from interface: DataExporter

Export data from the database to an external location.

Specified by:

exportData in interface DataExporter

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

setConnection

public void setConnection(org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> connectionConfiguration)
                   throws ConceptDatabaseConnectionException

Description copied from interface: DatabaseConnected

Requires the implementing service provider to check if the given connection is supported and, if so, to use it for later method calls. Please not that this kind of state requires caution in case of multithreading.

If the provider cannot serve to given connection configuration, it is required to throw a ConceptDatabaseConnectionException. This serves as the indication that the provider is not applicable for the required connection type. Typically, it will then just be omitted by its service.

Specified by:

setConnection in interface DatabaseConnected

Parameters:

connectionConfiguration - The connection details, e.g. HTTP, BOLT or file-based connection.

Throws:

ConceptDatabaseConnectionException - If the provider does not support the passed connection configuration.

getName

public String getName()

Specified by:

getName in interface de.julielab.jssf.commons.spi.ExtensionPoint

exposeParameters

public void exposeParameters(String basePath,
                             org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> template)

Specified by:

exposeParameters in interface de.julielab.jssf.commons.spi.ParameterExposing

Overrides:

exposeParameters in class RestCallBase