NES::SinkFormat Class Reference

#include <SinkFormat.hpp>

Public Member Functions
	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
virtual std::string	getFormattedSchema ()=0
	Returns the schema of formatted according to the specific SinkFormat represented as string. More...
virtual std::string	getFormattedBuffer (Runtime::TupleBuffer &inputBuffer)=0
	method to format a TupleBuffer More...
virtual FormatIterator	getTupleIterator (Runtime::TupleBuffer &inputBuffer)=0
	depending on the SinkFormat type, returns an iterator that can be used to retrieve tuples from the TupleBuffer More...
virtual std::string	toString ()=0
	method to return the format as a string More...
virtual FormatTypes	getSinkFormat ()=0
SchemaPtr	getSchemaPtr ()
void	setSchemaPtr (SchemaPtr schema)
Runtime::BufferManagerPtr	getBufferManager ()
void	setBufferManager (Runtime::BufferManagerPtr bufferManager)
bool	getAddTimestamp ()
void	setAddTimestamp (bool addTimestamp)

Protected Attributes
SchemaPtr	schema
Runtime::BufferManagerPtr	bufferManager
bool	addTimestamp

Constructor & Destructor Documentation

SinkFormat() [1/2]

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

constructor for a sink format

Parameters

schema
append

SinkFormat() [2/2]

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

constructor for a sink format

Parameters

schema	the schema
append	flag to append or not
addTimestamp	flag to add a timestamp in getFormattedBuffer

~SinkFormat()

virtual NES::SinkFormat::~SinkFormat ( )

virtualdefaultnoexcept

Member Function Documentation

getAddTimestamp()

bool NES::SinkFormat::getAddTimestamp

(

)

References addTimestamp.

getBufferManager()

Runtime::BufferManagerPtr NES::SinkFormat::getBufferManager

(

)

References bufferManager.

getFormattedBuffer()

virtual std::string NES::SinkFormat::getFormattedBuffer ( Runtime::TupleBuffer &  inputBuffer )

pure virtual

method to format a TupleBuffer

Parameters

a	tuple buffers pointer

Returns

formatted content of TupleBuffer

Implemented in NES::NesFormat, NES::JsonFormat, and NES::CsvFormat.

getFormattedSchema()

virtual std::string NES::SinkFormat::getFormattedSchema ( )

pure virtual

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

Returns

The formatted schema as string

Implemented in NES::NesFormat, NES::JsonFormat, and NES::CsvFormat.

getSchemaPtr()

SchemaPtr NES::SinkFormat::getSchemaPtr

(

)

References schema.

Referenced by NES::NesFormat::getFormattedBuffer().

Here is the caller graph for this function:

getSinkFormat()

virtual FormatTypes NES::SinkFormat::getSinkFormat ( )

pure virtual

Implemented in NES::NesFormat, NES::JsonFormat, and NES::CsvFormat.

getTupleIterator()

virtual FormatIterator NES::SinkFormat::getTupleIterator ( Runtime::TupleBuffer &  inputBuffer )

pure virtual

depending on the SinkFormat type, returns an iterator that can be used to retrieve tuples from the TupleBuffer

Parameters

a	tuple buffer pointer

Returns

TupleBuffer iterator

Implemented in NES::NesFormat, NES::JsonFormat, and NES::CsvFormat.

setAddTimestamp()

void NES::SinkFormat::setAddTimestamp

(

bool

addTimestamp

)

References addTimestamp.

setBufferManager()

void NES::SinkFormat::setBufferManager

(

Runtime::BufferManagerPtr

bufferManager

)

References bufferManager, and backward::details::move().

Here is the call graph for this function:

setSchemaPtr()

void NES::SinkFormat::setSchemaPtr

(

SchemaPtr

schema

)

References backward::details::move(), and schema.

Here is the call graph for this function:

toString()

virtual std::string NES::SinkFormat::toString ( )

pure virtual

method to return the format as a string

Returns

format as string

Implemented in NES::NesFormat, NES::JsonFormat, and NES::CsvFormat.

Member Data Documentation

addTimestamp

bool NES::SinkFormat::addTimestamp

protected

Referenced by getAddTimestamp(), NES::CsvFormat::getFormattedBuffer(), NES::CsvFormat::getFormattedSchema(), and setAddTimestamp().

bufferManager

Runtime::BufferManagerPtr NES::SinkFormat::bufferManager

protected

Referenced by getBufferManager(), and setBufferManager().

schema

SchemaPtr NES::SinkFormat::schema

protected

Referenced by NES::CsvFormat::getFormattedBuffer(), NES::CsvFormat::getFormattedSchema(), NES::NesFormat::getFormattedSchema(), getSchemaPtr(), NES::CsvFormat::getTupleIterator(), NES::JsonFormat::getTupleIterator(), and setSchemaPtr().

---

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

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