NES::CsvFormat Class Reference

#include <CsvFormat.hpp>

Collaboration diagram for NES::CsvFormat:

Public Member Functions
	CsvFormat (SchemaPtr schema, Runtime::BufferManagerPtr bufferManager, bool addTimestamp)
	CsvFormat (SchemaPtr schema, Runtime::BufferManagerPtr bufferManager)
virtual	~CsvFormat () noexcept=default
std::string	getFormattedSchema () override
	Returns the schema of formatted according to the specific SinkFormat represented as string. More...
std::string	getFormattedBuffer (Runtime::TupleBuffer &inputBuffer) override
	method to format a TupleBuffer More...
FormatIterator	getTupleIterator (Runtime::TupleBuffer &inputBuffer) override
	method to write a TupleBuffer More...
std::string	toString () override
	method to return the format as a string More...
FormatTypes	getSinkFormat () override
	return sink format More...
Public Member Functions inherited from NES::SinkFormat
	SinkFormat (SchemaPtr schema, Runtime::BufferManagerPtr bufferManager)
	constructor for a sink format More...
	SinkFormat (SchemaPtr schema, Runtime::BufferManagerPtr bufferManager, bool addTimestamp)
	constructor for a sink format More...
virtual	~SinkFormat () noexcept=default
SchemaPtr	getSchemaPtr ()
void	setSchemaPtr (SchemaPtr schema)
Runtime::BufferManagerPtr	getBufferManager ()
void	setBufferManager (Runtime::BufferManagerPtr bufferManager)
bool	getAddTimestamp ()
void	setAddTimestamp (bool addTimestamp)

Additional Inherited Members
Protected Attributes inherited from NES::SinkFormat
SchemaPtr	schema
Runtime::BufferManagerPtr	bufferManager
bool	addTimestamp

Constructor & Destructor Documentation

CsvFormat() [1/2]

NES::CsvFormat::CsvFormat	(	SchemaPtr	schema,
		Runtime::BufferManagerPtr	bufferManager,
		bool	addTimestamp
	)

Ctor for CSV format.

Parameters

schema	Ptr to the schema
bufferManager	Ptr to the buffer manager
addTimestamp	Flag, to indicate if timestamp shall be added when formatting

CsvFormat() [2/2]

NES::CsvFormat::CsvFormat	(	SchemaPtr	schema,
		Runtime::BufferManagerPtr	bufferManager
	)

~CsvFormat()

virtual NES::CsvFormat::~CsvFormat ( )

virtualdefaultnoexcept

Member Function Documentation

getFormattedBuffer()

std::string NES::CsvFormat::getFormattedBuffer ( Runtime::TupleBuffer &  inputBuffer )

overridevirtual

method to format a TupleBuffer

Parameters

a	tuple buffers pointer

Returns

formatted content of TupleBuffer, contains timestamp if specified

Implements NES::SinkFormat.

References NES::SinkFormat::addTimestamp, NES::Util::printTupleBufferAsCSV(), NES::SinkFormat::schema, and timestamp.

Here is the call graph for this function:

getFormattedSchema()

std::string NES::CsvFormat::getFormattedSchema ( )

overridevirtual

Returns the schema of formatted according to the specific SinkFormat represented as string.

Returns

The formatted schema as string

Implements NES::SinkFormat.

References NES::SinkFormat::addTimestamp, NES::SinkFormat::schema, NES::Util::toCSVString(), and NES::Util::trimWhiteSpaces().

Here is the call graph for this function:

getSinkFormat()

FormatTypes NES::CsvFormat::getSinkFormat ( )

overridevirtual

return sink format

Returns

sink format

Implements NES::SinkFormat.

References NES::CSV_FORMAT.

getTupleIterator()

FormatIterator NES::CsvFormat::getTupleIterator ( Runtime::TupleBuffer &  inputBuffer )

overridevirtual

method to write a TupleBuffer

Parameters

a	tuple buffers pointer

Returns

vector of Tuple buffer containing the content of the tuplebuffer

Implements NES::SinkFormat.

References NES::CSV_FORMAT, and NES::SinkFormat::schema.

toString()

std::string NES::CsvFormat::toString ( )

overridevirtual

method to return the format as a string

Returns

format as string

Implements NES::SinkFormat.

---

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

• /nebulastream/nes-runtime/include/Sinks/Formats/CsvFormat.hpp
• /nebulastream/nes-runtime/src/Sinks/Formats/CsvFormat.cpp