metrivis::SQL2JsonFetcher Class Reference

Represents a single process in the processing pipeline. More...

#include <SQL2JsonFetcher.h>

Inheritance diagram for metrivis::SQL2JsonFetcher:

Public Member Functions
	SQL2JsonFetcher ()
	Default constructor.
virtual	~SQL2JsonFetcher ()
	Deconstructor.
virtual void	Execute ()
	Executes the SQL2JsonFetcher. Produces ouput data from input.
virtual void	Reset ()
	Resets the pipeline process to it's original state.
void	set_table (const std::string &table)
	Interface function to member variable table.
void	set_target (const std::string &target)
	Interface function to member variable target.
void	set_action (const std::string &action)
	Interface function to member variable action.
void	set_argument (const std::string &argument)
	Interface function to member variable argument.
void	set_type (const std::string &type)
	Interface function to member variable type.
void	set_columns (const std::string &columns)
	Interface function to member variable type.
void	set_cached (const std::string &cached)
	Interface function to member variable cached.
Private Attributes
std::string	table_
	The SQL table name.
std::string	target_
	The SQL column names to retrieve.
std::string	action_
	The SQL action to execute.
std::string	argument_
	Arguments for an SQL argument (eg. for INSERT).
std::string	type_
	Type of the SQL data {double=default, string}.
std::string	columns_
	SQL column names for SQL INSERT.
std::string	cached_
	Set to "true" if the query should be cached.

---

Detailed Description

Represents a single process in the processing pipeline.

---

Constructor & Destructor Documentation

metrivis::SQL2JsonFetcher::SQL2JsonFetcher

(

)

Default constructor.

Constructor.

---

Member Function Documentation

void metrivis::SQL2JsonFetcher::Execute

(

)

[virtual]

Executes the SQL2JsonFetcher. Produces ouput data from input.

Executes this process and evaluates this input data and creates output from it. Abstract function needs to be overloaded.

See header file for more information.

Implements metrivis::PipelineProcess.

void metrivis::SQL2JsonFetcher::Reset

(

)

[virtual]

Resets the pipeline process to it's original state.

Frees resources. May take some time to execute, don't put it into speed critical sections. This is normally done after the execution of a pipeline. It automatically gets called from Pipeline::Reset.

See header file for more information.

Reimplemented from metrivis::PipelineProcess.

void metrivis::SQL2JsonFetcher::set_table

(

const std::string &

table

)

[inline]

Interface function to member variable table.

Parameters:

table,:

The SQL table to be used.

void metrivis::SQL2JsonFetcher::set_target

(

const std::string &

target

)

[inline]

Interface function to member variable target.

Parameters:

target,:

The name of the columns to retrieve.

void metrivis::SQL2JsonFetcher::set_action

(

const std::string &

action

)

[inline]

Interface function to member variable action.

Parameters:

action,:

The SQL action to be executed.

The action may be one of the following SQL commands:

• SELECT (requires table, target)
• INSERT (requires table, argument)
• DELETE (requires table, argument)

void metrivis::SQL2JsonFetcher::set_argument

(

const std::string &

argument

)

[inline]

Interface function to member variable argument.

Parameters:

argument,:

Arguments for the SQL request. Action specific.

void metrivis::SQL2JsonFetcher::set_type

(

const std::string &

type

)

[inline]

Interface function to member variable type.

Parameters:

type,:

Type of the return value {double = default, string}.

void metrivis::SQL2JsonFetcher::set_columns

(

const std::string &

columns

)

[inline]

Interface function to member variable type.

Parameters:

columns,:

SQL column names.

For SQL INSERT command, optional.

void metrivis::SQL2JsonFetcher::set_cached

(

const std::string &

cached

)

[inline]

Interface function to member variable cached.

Parameters:

cached,:

If this string == "true" then the request will be cached.

For any SQL SELECT query.

---

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

• src/SQL2JsonFetcher.h
• src/SQL2JsonFetcher.cc

---