IExportDestination Class Reference

#include <IExportDestination.h>

Inheritance diagram for IExportDestination:

Collaboration diagram for IExportDestination:

Public Member Functions
virtual	~IExportDestination ()=default
virtual void	consume (JsonContainerQueue::queue_t &queue)
std::pair< std::string, double >	getTimer ()
virtual const std::string	toString ()=0
virtual const std::string	toQueryString ()=0

Protected Member Functions
virtual void	consumeContainer (JsonContainerQueue::queue_t &queue)
virtual void	exportContainer (std::unique_ptr< JSONContainer > &&cont)=0
virtual const std::string	getTimerName ()=0

Protected Attributes
RecurringTimer	timer

Detailed Description

This Interface represents a method to export the documents contained in JODA

Constructor & Destructor Documentation

~IExportDestination()

virtual IExportDestination::~IExportDestination ( )

virtualdefault

Member Function Documentation

consume()

virtual void IExportDestination::consume ( JsonContainerQueue::queue_t &  queue )

inlinevirtual

Consumes (and times) a queue of containers. Normally this queue is filled with the results of a query.

Parameters

queue

The queue to consume from

Reimplemented in DirectoryExport.

Here is the call graph for this function:

consumeContainer()

virtual void IExportDestination::consumeContainer ( JsonContainerQueue::queue_t &  queue )

inlineprotectedvirtual

Reimplemented in StorageExport.

Here is the call graph for this function:

Here is the caller graph for this function:

exportContainer()

virtual void IExportDestination::exportContainer ( std::unique_ptr< JSONContainer > &&  cont )

protectedpure virtual

Implemented in StorageExport, JoinExport, FileExport, and DirectoryExport.

Here is the caller graph for this function:

getTimer()

std::pair<std::string, double> IExportDestination::getTimer ( )

inline

Returns a pair consisting of the name of the Export Destination and a time (in seconds) it required to consume the queues.

Returns

The timing of the execution.

Here is the call graph for this function:

getTimerName()

virtual const std::string IExportDestination::getTimerName ( )

protectedpure virtual

Implemented in StorageExport, JoinExport, FileExport, and DirectoryExport.

Here is the caller graph for this function:

toQueryString()

virtual const std::string IExportDestination::toQueryString ( )

pure virtual

Returns a string as this ExportDestination would be represented in a query

Returns

Implemented in StorageExport, JoinExport, FileExport, and DirectoryExport.

toString()

virtual const std::string IExportDestination::toString ( )

pure virtual

Returns a (human readable) string describing the ExportDestination. A.toString() == B.toString() => A == B

Returns

Implemented in StorageExport, JoinExport, FileExport, and DirectoryExport.

Field Documentation

timer

RecurringTimer IExportDestination::timer

protected

---

The documentation for this class was generated from the following file:

• /home/nico/joda_tmp/tmp-joda-dirs/JODA-gh/libs/joda/core/modules/export/include/joda/export/IExportDestination.h