joda::docparsing::DefaultContainerScheduler< meta > Class Template Reference

#include <DefaultContainerScheduler.h>

Public Types
typedef short	ContainerIdentifier

Public Member Functions
	DefaultContainerScheduler (JsonContainerQueue::queue_t *queue, size_t contSize=0)
ContainerIdentifier	getContainerForDoc (const RJDocument &doc)
ContainerIdentifier	getContainerForDoc (std::string &raw)
ContainerIdentifier	getContainerForDoc (rapidjson::IStreamWrapper &stream)
void	scheduleDocument (ContainerIdentifier id, std::unique_ptr< RJDocument > &&doc, std::unique_ptr< IOrigin > &&origin, size_t size)
std::unique_ptr< RJDocument >	getNewDoc (ContainerIdentifier id)
void	finalize ()
virtual	~DefaultContainerScheduler ()=default
void	scheduleDocument (ContainerIdentifier, std::unique_ptr< RJDocument > &&doc, std::unique_ptr< IOrigin > &&origin, size_t size)
void	scheduleDocument (ContainerIdentifier, std::unique_ptr< RJDocument > &&doc, std::unique_ptr< IOrigin > &&origin, size_t size)
void	finalize ()
void	finalize ()

Detailed Description

template<bool meta>
class joda::docparsing::DefaultContainerScheduler< meta >

A document scheduler scheduling the documents into the same container

Template Parameters

meta	If the Container should be meta finalized or really finalized

Member Typedef Documentation

ContainerIdentifier

template<bool meta>

typedef short joda::docparsing::DefaultContainerScheduler< meta >::ContainerIdentifier

Constructor & Destructor Documentation

DefaultContainerScheduler()

template<bool meta>

joda::docparsing::DefaultContainerScheduler< meta >::DefaultContainerScheduler	(	JsonContainerQueue::queue_t *	queue,
		size_t	contSize = 0
	)

Constructs a scheduler for use within the parsers.

Parameters

queue	The container queue to use to pass finalized containers through.
contSize	The size of newly constructed containers.

~DefaultContainerScheduler()

template<bool meta>

virtual joda::docparsing::DefaultContainerScheduler< meta >::~DefaultContainerScheduler ( )

virtualdefault

Member Function Documentation

finalize() [1/3]

void joda::docparsing::DefaultContainerScheduler< true >::finalize

(

)

finalize() [2/3]

void joda::docparsing::DefaultContainerScheduler< false >::finalize

(

)

finalize() [3/3]

template<bool meta>

void joda::docparsing::DefaultContainerScheduler< meta >::finalize

(

)

Finalizes the Scheduler. Has to be called before deconstructing it.

getContainerForDoc() [1/3]

template<bool meta>

joda::docparsing::DefaultContainerScheduler< meta >::ContainerIdentifier joda::docparsing::DefaultContainerScheduler< meta >::getContainerForDoc

(

const RJDocument &

doc

)

Always returns 0, as this scheduler does not require an id

Parameters

doc	The document

Returns

0

getContainerForDoc() [2/3]

template<bool meta>

joda::docparsing::DefaultContainerScheduler< meta >::ContainerIdentifier joda::docparsing::DefaultContainerScheduler< meta >::getContainerForDoc

(

rapidjson::IStreamWrapper &

stream

)

Always returns 0, as this scheduler does not require an id

Parameters

stream

The stream to check against

Returns

0

getContainerForDoc() [3/3]

template<bool meta>

joda::docparsing::DefaultContainerScheduler< meta >::ContainerIdentifier joda::docparsing::DefaultContainerScheduler< meta >::getContainerForDoc

(

std::string &

raw

)

Always returns 0, as this scheduler does not require an id

Parameters

raw	The document in string representation (before parsing)

Returns

0

getNewDoc()

template<bool meta>

std::unique_ptr< RJDocument > joda::docparsing::DefaultContainerScheduler< meta >::getNewDoc

(

ContainerIdentifier

id

)

Returns a document initialized with the allocator of the container represented by id

Parameters

id	The id representing the container

Returns

A new document

scheduleDocument() [1/3]

template<bool meta>

void joda::docparsing::DefaultContainerScheduler< meta >::scheduleDocument	(	ContainerIdentifier	id,
		std::unique_ptr< RJDocument > &&	doc,
		std::unique_ptr< IOrigin > &&	origin,
		size_t	size
	)

Schedules the document into the container given by id.

Parameters

id	The id of the container
doc	The document to schedule
origin	The origin of the document
size	The size of the document (bytes)

scheduleDocument() [2/3]

void joda::docparsing::DefaultContainerScheduler< true >::scheduleDocument	(	ContainerIdentifier	,
		std::unique_ptr< RJDocument > &&	doc,
		std::unique_ptr< IOrigin > &&	origin,
		size_t	size
	)

scheduleDocument() [3/3]

void joda::docparsing::DefaultContainerScheduler< false >::scheduleDocument	(	ContainerIdentifier	,
		std::unique_ptr< RJDocument > &&	doc,
		std::unique_ptr< IOrigin > &&	origin,
		size_t	size
	)

---

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

• /home/nico/joda_tmp/tmp-joda-dirs/JODA-gh/libs/joda/core/modules/parser/src/parsers/ContainerScheduler/DefaultContainerScheduler.h
• /home/nico/joda_tmp/tmp-joda-dirs/JODA-gh/libs/joda/core/modules/parser/src/parsers/ContainerScheduler/DefaultContainerScheduler.cpp