NebulaStream  0.6.213
NebulaStream is a data and application management framework for the internet of things
Public Member Functions | Protected Attributes | List of all members
NES::Statistic::AbstractStatisticFormat Class Referenceabstract

An interface for parsing (reading and creating) statistics from/to a TupleBuffer. The idea is that this format is called in the StatisticSink as well as the operator handler and returns multiple statistics that are then inserted into a StatisticStorage. More...

#include <AbstractStatisticFormat.hpp>

Public Member Functions

 AbstractStatisticFormat (const Schema &schema, Runtime::MemoryLayouts::MemoryLayoutPtr memoryLayout, std::function< std::string(const std::string &)> postProcessingData, std::function< std::string(const std::string &)> preProcessingData)
 
 AbstractStatisticFormat (const std::string &qualifierNameWithSeparator, Runtime::MemoryLayouts::MemoryLayoutPtr memoryLayout, std::function< std::string(const std::string &)> postProcessingData, std::function< std::string(const std::string &)> preProcessingData)
 
virtual std::vector< HashStatisticPair > readStatisticsFromBuffer (Runtime::TupleBuffer &buffer)=0
 Reads the statistics from the buffer. More...
 
virtual std::vector< Runtime::TupleBuffer > writeStatisticsIntoBuffers (const std::vector< HashStatisticPair > &statisticsPlusHashes, Runtime::BufferManager &bufferManager)=0
 Writes the statistics to the buffer. More...
 
virtual std::string toString () const =0
 
virtual ~AbstractStatisticFormat ()
 

Protected Attributes

const Runtime::MemoryLayouts::MemoryLayoutPtr memoryLayout
 
const std::string startTsFieldName
 
const std::string endTsFieldName
 
const std::string statisticHashFieldName
 
const std::string statisticTypeFieldName
 
const std::string observedTuplesFieldName
 
const std::function< std::string(const std::string &)> postProcessingData
 
const std::function< std::string(const std::string &)> preProcessingData
 

Detailed Description

An interface for parsing (reading and creating) statistics from/to a TupleBuffer. The idea is that this format is called in the StatisticSink as well as the operator handler and returns multiple statistics that are then inserted into a StatisticStorage.

Constructor & Destructor Documentation

◆ AbstractStatisticFormat() [1/2]

NES::Statistic::AbstractStatisticFormat::AbstractStatisticFormat ( const Schema &  schema,
Runtime::MemoryLayouts::MemoryLayoutPtr  memoryLayout,
std::function< std::string(const std::string &)>  postProcessingData,
std::function< std::string(const std::string &)>  preProcessingData 
)
explicit

◆ AbstractStatisticFormat() [2/2]

NES::Statistic::AbstractStatisticFormat::AbstractStatisticFormat ( const std::string &  qualifierNameWithSeparator,
Runtime::MemoryLayouts::MemoryLayoutPtr  memoryLayout,
std::function< std::string(const std::string &)>  postProcessingData,
std::function< std::string(const std::string &)>  preProcessingData 
)
explicit

◆ ~AbstractStatisticFormat()

NES::Statistic::AbstractStatisticFormat::~AbstractStatisticFormat ( )
virtualdefault

Member Function Documentation

◆ readStatisticsFromBuffer()

virtual std::vector<HashStatisticPair> NES::Statistic::AbstractStatisticFormat::readStatisticsFromBuffer ( Runtime::TupleBuffer &  buffer)
pure virtual

Reads the statistics from the buffer.

Parameters
bufferBuffer containing the
Returns
Pairs of <StatisticHash, Statistic>

Implemented in NES::Statistic::HyperLogLogStatisticFormat, and NES::Statistic::CountMinStatisticFormat.

◆ toString()

virtual std::string NES::Statistic::AbstractStatisticFormat::toString ( ) const
pure virtual

Implemented in NES::Statistic::HyperLogLogStatisticFormat, and NES::Statistic::CountMinStatisticFormat.

◆ writeStatisticsIntoBuffers()

virtual std::vector<Runtime::TupleBuffer> NES::Statistic::AbstractStatisticFormat::writeStatisticsIntoBuffers ( const std::vector< HashStatisticPair > &  statisticsPlusHashes,
Runtime::BufferManager &  bufferManager 
)
pure virtual

Writes the statistics to the buffer.

Parameters
statisticsPlusHashes
bufferManager
Returns
Vector of tuple buffers containing the sketches

Implemented in NES::Statistic::HyperLogLogStatisticFormat, and NES::Statistic::CountMinStatisticFormat.

Member Data Documentation

◆ endTsFieldName

const std::string NES::Statistic::AbstractStatisticFormat::endTsFieldName
protected

Referenced by NES::Statistic::CountMinStatisticFormat::readStatisticsFromBuffer(), NES::Statistic::HyperLogLogStatisticFormat::readStatisticsFromBuffer(), NES::Statistic::CountMinStatisticFormat::toString(), NES::Statistic::HyperLogLogStatisticFormat::toString(), NES::Statistic::CountMinStatisticFormat::writeStatisticsIntoBuffers(), and NES::Statistic::HyperLogLogStatisticFormat::writeStatisticsIntoBuffers().

◆ memoryLayout

const Runtime::MemoryLayouts::MemoryLayoutPtr NES::Statistic::AbstractStatisticFormat::memoryLayout
protected

Referenced by NES::Statistic::CountMinStatisticFormat::create(), NES::Statistic::HyperLogLogStatisticFormat::create(), NES::Statistic::CountMinStatisticFormat::readStatisticsFromBuffer(), NES::Statistic::HyperLogLogStatisticFormat::readStatisticsFromBuffer(), NES::Statistic::CountMinStatisticFormat::writeStatisticsIntoBuffers(), and NES::Statistic::HyperLogLogStatisticFormat::writeStatisticsIntoBuffers().

◆ observedTuplesFieldName

const std::string NES::Statistic::AbstractStatisticFormat::observedTuplesFieldName
protected

Referenced by NES::Statistic::CountMinStatisticFormat::readStatisticsFromBuffer(), NES::Statistic::HyperLogLogStatisticFormat::readStatisticsFromBuffer(), NES::Statistic::CountMinStatisticFormat::toString(), NES::Statistic::HyperLogLogStatisticFormat::toString(), NES::Statistic::CountMinStatisticFormat::writeStatisticsIntoBuffers(), and NES::Statistic::HyperLogLogStatisticFormat::writeStatisticsIntoBuffers().

◆ postProcessingData

const std::function<std::string(const std::string&)> NES::Statistic::AbstractStatisticFormat::postProcessingData
protected

Referenced by NES::Statistic::CountMinStatisticFormat::create(), NES::Statistic::HyperLogLogStatisticFormat::create(), NES::Statistic::CountMinStatisticFormat::readStatisticsFromBuffer(), and NES::Statistic::HyperLogLogStatisticFormat::readStatisticsFromBuffer().

◆ preProcessingData

const std::function<std::string(const std::string&)> NES::Statistic::AbstractStatisticFormat::preProcessingData
protected

Referenced by NES::Statistic::CountMinStatisticFormat::create(), NES::Statistic::HyperLogLogStatisticFormat::create(), NES::Statistic::CountMinStatisticFormat::writeStatisticsIntoBuffers(), and NES::Statistic::HyperLogLogStatisticFormat::writeStatisticsIntoBuffers().

◆ startTsFieldName

const std::string NES::Statistic::AbstractStatisticFormat::startTsFieldName
protected

Referenced by NES::Statistic::CountMinStatisticFormat::readStatisticsFromBuffer(), NES::Statistic::HyperLogLogStatisticFormat::readStatisticsFromBuffer(), NES::Statistic::CountMinStatisticFormat::toString(), NES::Statistic::HyperLogLogStatisticFormat::toString(), NES::Statistic::CountMinStatisticFormat::writeStatisticsIntoBuffers(), and NES::Statistic::HyperLogLogStatisticFormat::writeStatisticsIntoBuffers().

◆ statisticHashFieldName

const std::string NES::Statistic::AbstractStatisticFormat::statisticHashFieldName
protected

Referenced by NES::Statistic::CountMinStatisticFormat::readStatisticsFromBuffer(), NES::Statistic::HyperLogLogStatisticFormat::readStatisticsFromBuffer(), NES::Statistic::CountMinStatisticFormat::toString(), NES::Statistic::HyperLogLogStatisticFormat::toString(), NES::Statistic::CountMinStatisticFormat::writeStatisticsIntoBuffers(), and NES::Statistic::HyperLogLogStatisticFormat::writeStatisticsIntoBuffers().

◆ statisticTypeFieldName

const std::string NES::Statistic::AbstractStatisticFormat::statisticTypeFieldName
protected

Referenced by NES::Statistic::CountMinStatisticFormat::toString(), and NES::Statistic::HyperLogLogStatisticFormat::toString().

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