com.denodo.scheduler.api.exporter

Interface Exporter

All Known Subinterfaces:

ExporterWithContext

public interface Exporter

Exports retrieved information to several targets, such as data bases, files and indexes. Provides a default empty method for exporting with context, so that current implementations of this interface are not broken.

Method Summary

Modifier and Type	Method and Description
void	export(Collection<Document> documents) Exports the documents.
default void	export(Collection<Document> documents, ExporterQueryContext queryContext) Exports the documents, with their related ExporterQueryContext.
String	getName()
void	init(ParameterStructure parameters) Initializes the exporter and tests whether the ServerDataSources the exporter needed for exporting data (if any) is reachable and has been correctly configured.
default void	interrupt()

Method Detail

init

void init(ParameterStructure parameters)
   throws ConfigurationException,
          ConnectException,
          InternalErrorException

Initializes the exporter and tests whether the ServerDataSources the exporter needed for exporting data (if any) is reachable and has been correctly configured.

Parameters:

parameters - parameters to initialize the exporter.

Throws:

ConfigurationException - if the configuration information required by the exporter is malformed or missing.

ConnectException - if a connection error occurs. Typically, the connection to a ServerDataSource was refused remotely.

InternalErrorException - if a severe error occurs.

getName

String getName()

export

void export(Collection<Document> documents)
     throws ExporterException

Exports the documents.

Parameters:

documents - Collection of Documents

Throws:

ExporterException

export

default void export(Collection<Document> documents,
                    ExporterQueryContext queryContext)
             throws ExporterException

Exports the documents, with their related ExporterQueryContext.

Parameters:

documents - Collection of Documents to export

queryContext - Context with the query and its parameters that originated those Documents to export

Throws:

ExporterException

interrupt

default void interrupt()
                throws ExporterException

Throws:

ExporterException