crawlservpp::Struct::QueryProperties Struct Reference

Query properties containing its name, text, type, and result type(s). More...

#include <QueryProperties.hpp>

Properties
std::string	name
	The name of the query. More...
std::string	text
	The query. More...
std::string	type
	The type of the query. More...
bool	resultBool {false}
	Indicates whether the query generates a boolean result. More...
bool	resultSingle {false}
	Indicates whether the query generates a single result. More...
bool	resultMulti {false}
	Indicates whether the query generates multiple results. More...
bool	resultSubSets {false}
	Indicates whether the query generates subsets as results. More...
bool	textOnly {false}
	Indicates whether the query should be considered text-only. More...

Construction
	QueryProperties ()=default
	Default constructor. More...
	QueryProperties (const std::string &setName, const std::string &setText, const std::string &setType, bool setResultBool, bool setResultSingle, bool setResultMulti, bool setResultSubSets, bool setTextOnly)
	Constructor setting properties, including the name of the query. More...
	QueryProperties (const std::string &setText, const std::string &setType, bool setResultBool, bool setResultSingle, bool setResultMulti, bool setResultSubSets, bool setTextOnly)
	Constructor setting properties, but not the name of the query. More...

Detailed Description

Query properties containing its name, text, type, and result type(s).

Constructor & Destructor Documentation

QueryProperties() [1/3]

crawlservpp::Struct::QueryProperties::QueryProperties ( )

default

Default constructor.

QueryProperties() [2/3]

crawlservpp::Struct::QueryProperties::QueryProperties ( const std::string &  setName, const std::string &  setText, const std::string &  setType, bool  setResultBool, bool  setResultSingle, bool  setResultMulti, bool  setResultSubSets, bool  setTextOnly  )

inline

Constructor setting properties, including the name of the query.

Parameters

setName	Constant reference to a string containing the name of the query.
setText	Constant reference to a string containing the text of the query.
setType	Constant reference to a string containing the type of the query.
setResultBool	Set whether the query generates a boolean result.
setResultSingle	Set whether the query generates a single result.
setResultMulti	Set whether the query generates multiple results.
setResultSubSets	Set whether the query generates subsets as results.
setTextOnly	Set whether the query should be considered text-only.

QueryProperties() [3/3]

crawlservpp::Struct::QueryProperties::QueryProperties ( const std::string &  setText, const std::string &  setType, bool  setResultBool, bool  setResultSingle, bool  setResultMulti, bool  setResultSubSets, bool  setTextOnly  )

inline

Constructor setting properties, but not the name of the query.

Note

The name of the query will be set to an empty string.

Parameters

setText	Constant reference to a string containing the text of the query.
setType	Constant reference to a string containing the type of the query.
setResultBool	Set whether the query generates a boolean result.
setResultSingle	Set whether the query generates a single result.
setResultMulti	Set whether the query generates multiple results.
setResultSubSets	Set whether the query generates subsets as results.
setTextOnly	Set whether the query should be considered text- only.

Member Data Documentation

name

std::string crawlservpp::Struct::QueryProperties::name

The name of the query.

Referenced by crawlservpp::Main::Database::addQuery(), and crawlservpp::Main::Database::updateQuery().

resultBool

bool crawlservpp::Struct::QueryProperties::resultBool {false}

Indicates whether the query generates a boolean result.

Referenced by crawlservpp::Query::Container::addQuery(), crawlservpp::Main::Database::addQuery(), crawlservpp::Module::Extractor::Thread::onReset(), crawlservpp::Main::Server::tick(), and crawlservpp::Main::Database::updateQuery().

resultMulti

bool crawlservpp::Struct::QueryProperties::resultMulti {false}

Indicates whether the query generates multiple results.

Referenced by crawlservpp::Query::Container::addQuery(), crawlservpp::Main::Database::addQuery(), and crawlservpp::Main::Database::updateQuery().

resultSingle

bool crawlservpp::Struct::QueryProperties::resultSingle {false}

Indicates whether the query generates a single result.

Referenced by crawlservpp::Query::Container::addQuery(), crawlservpp::Main::Database::addQuery(), crawlservpp::Module::Extractor::Thread::onReset(), and crawlservpp::Main::Database::updateQuery().

resultSubSets

bool crawlservpp::Struct::QueryProperties::resultSubSets {false}

Indicates whether the query generates subsets as results.

Subsets can directly be used to run queries on them again.

Referenced by crawlservpp::Query::Container::addQuery(), crawlservpp::Main::Database::addQuery(), and crawlservpp::Main::Database::updateQuery().

text

std::string crawlservpp::Struct::QueryProperties::text

The query.

Referenced by crawlservpp::Query::Container::addQuery(), crawlservpp::Main::Database::addQuery(), crawlservpp::Main::Server::tick(), and crawlservpp::Main::Database::updateQuery().

textOnly

bool crawlservpp::Struct::QueryProperties::textOnly {false}

Indicates whether the query should be considered text-only.

Referenced by crawlservpp::Query::Container::addQuery(), crawlservpp::Main::Database::addQuery(), and crawlservpp::Main::Database::updateQuery().

type

std::string crawlservpp::Struct::QueryProperties::type

The type of the query.

Referenced by crawlservpp::Query::Container::addQuery(), crawlservpp::Main::Database::addQuery(), crawlservpp::Module::Extractor::Thread::onReset(), crawlservpp::Main::Server::tick(), and crawlservpp::Main::Database::updateQuery().

---

The documentation for this struct was generated from the following file:

• Struct/QueryProperties.hpp