joda::docparsing::IImportSource Class Reference

#include <IImportSource.h>

Inheritance diagram for joda::docparsing::IImportSource:

Public Member Functions
	IImportSource (ReaderFlag readerFlag, ParserFlag parserFlag, ContainerFlag containerFlag)
virtual	~IImportSource ()=default
ReaderFlag	getReaderFlag () const
ParserFlag	getParserFlag () const
ContainerFlag	getContainerFlag () const
virtual void	feedSources (JODA_READER_QUEUE< JODA_JSON_FILE_LINESEPERATED_READER_FLAG >::queue_t &queue, JODA_READER_QUEUE< JODA_JSON_FILE_LINESEPERATED_READER_FLAG >::queue_t::ptok_t &ptok)
virtual void	feedSources (JODA_READER_QUEUE< JODA_JSON_FILE_BEAUTIFIED_READER_FLAG >::queue_t &queue, JODA_READER_QUEUE< JODA_JSON_FILE_BEAUTIFIED_READER_FLAG >::queue_t::ptok_t &ptok)
virtual void	feedSources (JODA_READER_QUEUE< JODA_JSON_URL_READER_FLAG >::queue_t &queue, JODA_READER_QUEUE< JODA_JSON_URL_READER_FLAG >::queue_t::ptok_t &ptok)
virtual const std::string	toString ()=0
virtual const std::string	toQueryString ()=0
virtual size_t	estimatedSize ()

Detailed Description

Interface representing a list of documents to be imported into the system.

Constructor & Destructor Documentation

IImportSource()

joda::docparsing::IImportSource::IImportSource ( ReaderFlag  readerFlag, ParserFlag  parserFlag, ContainerFlag  containerFlag  )

inline

Initializes a new IImportSource with the given flags

Parameters

readerFlag	the flags required by the reader to be able to read the documents
parserFlag	the flags required by the parser to be able to parse the documents
containerFlag	the flags required by the container to be able to store the documents

~IImportSource()

virtual joda::docparsing::IImportSource::~IImportSource ( )

virtualdefault

Member Function Documentation

estimatedSize()

virtual size_t joda::docparsing::IImportSource::estimatedSize ( )

inlinevirtual

Estimates the size of the document to be imported

Reimplemented in joda::docparsing::JSONURLSource, joda::docparsing::JSONFileSource, and joda::docparsing::JSONFileDirectorySource.

Here is the caller graph for this function:

feedSources() [1/3]

virtual void joda::docparsing::IImportSource::feedSources ( JODA_READER_QUEUE< JODA_JSON_FILE_BEAUTIFIED_READER_FLAG >::queue_t &  queue, JODA_READER_QUEUE< JODA_JSON_FILE_BEAUTIFIED_READER_FLAG >::queue_t::ptok_t &  ptok  )

inlinevirtual

Reimplemented in joda::docparsing::JSONFileSource, and joda::docparsing::JSONFileDirectorySource.

feedSources() [2/3]

virtual void joda::docparsing::IImportSource::feedSources ( JODA_READER_QUEUE< JODA_JSON_FILE_LINESEPERATED_READER_FLAG >::queue_t &  queue, JODA_READER_QUEUE< JODA_JSON_FILE_LINESEPERATED_READER_FLAG >::queue_t::ptok_t &  ptok  )

inlinevirtual

Reimplemented in joda::docparsing::JSONFileSource, and joda::docparsing::JSONFileDirectorySource.

feedSources() [3/3]

virtual void joda::docparsing::IImportSource::feedSources ( JODA_READER_QUEUE< JODA_JSON_URL_READER_FLAG >::queue_t &  queue, JODA_READER_QUEUE< JODA_JSON_URL_READER_FLAG >::queue_t::ptok_t &  ptok  )

inlinevirtual

getContainerFlag()

ContainerFlag joda::docparsing::IImportSource::getContainerFlag ( ) const

inline

getParserFlag()

ParserFlag joda::docparsing::IImportSource::getParserFlag ( ) const

inline

getReaderFlag()

ReaderFlag joda::docparsing::IImportSource::getReaderFlag ( ) const

inline

toQueryString()

virtual const std::string joda::docparsing::IImportSource::toQueryString ( )

pure virtual

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

Returns

Implemented in joda::docparsing::JSONURLSource, joda::docparsing::JSONFileSource, and joda::docparsing::JSONFileDirectorySource.

toString()

virtual const std::string joda::docparsing::IImportSource::toString ( )

pure virtual

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

Returns

Implemented in joda::docparsing::JSONURLSource, joda::docparsing::JSONFileSource, and joda::docparsing::JSONFileDirectorySource.

---

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

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