crawlservpp::Struct::QueryStruct Struct Reference

Structure to identify a query including its type and result type(s). More...

#include <QueryStruct.hpp>

Constants
static constexpr std::uint8_t	typeNone {0}
	Unspecified query type. More...
static constexpr std::uint8_t	typeRegEx {1}
	Query type identifying a RegEx query. More...
static constexpr std::uint8_t	typeXPath {2}
	Query type identifying a XPath query. More...
static constexpr std::uint8_t	typeJsonPointer {3}
	Query type identifying a JSONPointer query. More...
static constexpr std::uint8_t	typeJsonPath {4}
	Query type identifying a JSONPath query. More...
static constexpr std::uint8_t	typeXPathJsonPointer {5}
	Query type identifying a combined XPath and JSONPointer query. More...
static constexpr std::uint8_t	typeXPathJsonPath {6}
	Query type identifying a combined XPath and JSONPath query. More...

Properties
std::uint8_t	type {QueryStruct::typeNone}
	The type of the query (see above). More...
std::size_t	index {}
	The index of the query inside its container. 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...

Construction
	QueryStruct ()=default
	Default constructor. More...
	QueryStruct (std::uint8_t setType, std::size_t setIndex, bool setResultBool, bool setResultSingle, bool setResultMulti, bool setResultSubSets)
	Constructor explicitly setting the properties. More...

Getter
bool	valid () const noexcept
	Gets whether the query is valid, i.e. whether a query ID has been identified. More...

Detailed Description

Structure to identify a query including its type and result type(s).

Constructor & Destructor Documentation

QueryStruct() [1/2]

crawlservpp::Struct::QueryStruct::QueryStruct ( )

default

Default constructor.

QueryStruct() [2/2]

crawlservpp::Struct::QueryStruct::QueryStruct ( std::uint8_t  setType, std::size_t  setIndex, bool  setResultBool, bool  setResultSingle, bool  setResultMulti, bool  setResultSubSets  )

inline

Constructor explicitly setting the properties.

Parameters

setType	The type of the query (see above).
setIndex	The index 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.

Member Function Documentation

valid()

bool crawlservpp::Struct::QueryStruct::valid ( ) const

inlinenoexcept

Gets whether the query is valid, i.e. whether a query ID has been identified.

Returns

True, if the query is valid and a query ID has been identified. False otherwise.

References index.

Referenced by crawlservpp::Module::Extractor::Thread::onReset().

Member Data Documentation

index

std::size_t crawlservpp::Struct::QueryStruct::index {}

The index of the query inside its container.

Referenced by crawlservpp::Query::Container::addQuery(), crawlservpp::Query::Container::addSubSetsFromQueryOnSubSet(), crawlservpp::Query::Container::getBoolFromQuery(), crawlservpp::Query::Container::getBoolFromQueryOnSubSet(), crawlservpp::Query::Container::getBoolFromRegEx(), crawlservpp::Query::Container::getMultiFromQuery(), crawlservpp::Query::Container::getMultiFromQueryOnSubSet(), crawlservpp::Query::Container::getMultiFromRegEx(), crawlservpp::Query::Container::getSingleFromQuery(), crawlservpp::Query::Container::getSingleFromQueryOnSubSet(), crawlservpp::Query::Container::getSingleFromRegEx(), crawlservpp::Query::Container::setSubSetsFromQuery(), and valid().

resultBool

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

Indicates whether the query generates a boolean result.

Referenced by crawlservpp::Query::Container::addQuery(), crawlservpp::Query::Container::getBoolFromQuery(), crawlservpp::Query::Container::getBoolFromQueryOnSubSet(), crawlservpp::Query::Container::getBoolFromRegEx(), and crawlservpp::Module::Extractor::Thread::onReset().

resultMulti

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

Indicates whether the query generates multiple results.

Referenced by crawlservpp::Query::Container::addQuery(), crawlservpp::Query::Container::getMultiFromQuery(), crawlservpp::Query::Container::getMultiFromQueryOnSubSet(), crawlservpp::Query::Container::getMultiFromRegEx(), and crawlservpp::Module::Extractor::Thread::onReset().

resultSingle

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

Indicates whether the query generates a single result.

Referenced by crawlservpp::Query::Container::addQuery(), crawlservpp::Query::Container::getSingleFromQuery(), crawlservpp::Query::Container::getSingleFromQueryOnSubSet(), crawlservpp::Query::Container::getSingleFromRegEx(), and crawlservpp::Module::Extractor::Thread::onReset().

resultSubSets

bool crawlservpp::Struct::QueryStruct::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::Query::Container::addSubSetsFromQueryOnSubSet(), and crawlservpp::Query::Container::setSubSetsFromQuery().

type

std::uint8_t crawlservpp::Struct::QueryStruct::type {QueryStruct::typeNone}

The type of the query (see above).

Referenced by crawlservpp::Query::Container::addQuery(), crawlservpp::Query::Container::addSubSetsFromQueryOnSubSet(), crawlservpp::Query::Container::getBoolFromQuery(), crawlservpp::Query::Container::getBoolFromQueryOnSubSet(), crawlservpp::Query::Container::getBoolFromRegEx(), crawlservpp::Query::Container::getMultiFromQuery(), crawlservpp::Query::Container::getMultiFromQueryOnSubSet(), crawlservpp::Query::Container::getMultiFromRegEx(), crawlservpp::Query::Container::getSingleFromQuery(), crawlservpp::Query::Container::getSingleFromQueryOnSubSet(), crawlservpp::Query::Container::getSingleFromRegEx(), crawlservpp::Module::Extractor::Thread::onReset(), crawlservpp::Query::Container::reserveForSubSets(), and crawlservpp::Query::Container::setSubSetsFromQuery().

typeJsonPath

constexpr std::uint8_t crawlservpp::Struct::QueryStruct::typeJsonPath {4}

inlinestatic

Query type identifying a JSONPath query.

Referenced by crawlservpp::Query::Container::addQuery(), crawlservpp::Query::Container::addSubSetsFromQueryOnSubSet(), crawlservpp::Query::Container::getBoolFromQuery(), crawlservpp::Query::Container::getBoolFromQueryOnSubSet(), crawlservpp::Query::Container::getMultiFromQuery(), crawlservpp::Query::Container::getMultiFromQueryOnSubSet(), crawlservpp::Query::Container::getSingleFromQuery(), crawlservpp::Query::Container::getSingleFromQueryOnSubSet(), crawlservpp::Query::Container::nextSubSet(), crawlservpp::Query::Container::reserveForSubSets(), and crawlservpp::Query::Container::setSubSetsFromQuery().

typeJsonPointer

constexpr std::uint8_t crawlservpp::Struct::QueryStruct::typeJsonPointer {3}

inlinestatic

Query type identifying a JSONPointer query.

Referenced by crawlservpp::Query::Container::addQuery(), crawlservpp::Query::Container::addSubSetsFromQueryOnSubSet(), crawlservpp::Query::Container::getBoolFromQuery(), crawlservpp::Query::Container::getBoolFromQueryOnSubSet(), crawlservpp::Query::Container::getMultiFromQuery(), crawlservpp::Query::Container::getMultiFromQueryOnSubSet(), crawlservpp::Query::Container::getSingleFromQuery(), crawlservpp::Query::Container::getSingleFromQueryOnSubSet(), crawlservpp::Query::Container::nextSubSet(), crawlservpp::Query::Container::reserveForSubSets(), and crawlservpp::Query::Container::setSubSetsFromQuery().

typeNone

constexpr std::uint8_t crawlservpp::Struct::QueryStruct::typeNone {0}

inlinestatic

Unspecified query type.

Referenced by crawlservpp::Query::Container::addSubSetsFromQueryOnSubSet(), crawlservpp::Query::Container::getBoolFromQuery(), crawlservpp::Query::Container::getBoolFromQueryOnSubSet(), crawlservpp::Query::Container::getBoolFromRegEx(), crawlservpp::Query::Container::getMultiFromQuery(), crawlservpp::Query::Container::getMultiFromQueryOnSubSet(), crawlservpp::Query::Container::getMultiFromRegEx(), crawlservpp::Query::Container::getSingleFromQuery(), crawlservpp::Query::Container::getSingleFromQueryOnSubSet(), crawlservpp::Query::Container::getSingleFromRegEx(), crawlservpp::Module::Parser::Thread::onReset(), crawlservpp::Module::Extractor::Thread::onReset(), crawlservpp::Module::Crawler::Thread::onReset(), crawlservpp::Query::Container::reserveForSubSets(), and crawlservpp::Query::Container::setSubSetsFromQuery().

typeRegEx

constexpr std::uint8_t crawlservpp::Struct::QueryStruct::typeRegEx {1}

inlinestatic

Query type identifying a RegEx query.

Referenced by crawlservpp::Query::Container::addQuery(), crawlservpp::Query::Container::addSubSetsFromQueryOnSubSet(), crawlservpp::Query::Container::getBoolFromQuery(), crawlservpp::Query::Container::getBoolFromQueryOnSubSet(), crawlservpp::Query::Container::getBoolFromRegEx(), crawlservpp::Query::Container::getMultiFromQuery(), crawlservpp::Query::Container::getMultiFromQueryOnSubSet(), crawlservpp::Query::Container::getMultiFromRegEx(), crawlservpp::Query::Container::getSingleFromQuery(), crawlservpp::Query::Container::getSingleFromQueryOnSubSet(), crawlservpp::Query::Container::getSingleFromRegEx(), crawlservpp::Module::Extractor::Thread::onReset(), crawlservpp::Query::Container::reserveForSubSets(), and crawlservpp::Query::Container::setSubSetsFromQuery().

typeXPath

constexpr std::uint8_t crawlservpp::Struct::QueryStruct::typeXPath {2}

inlinestatic

Query type identifying a XPath query.

Referenced by crawlservpp::Query::Container::addQuery(), crawlservpp::Query::Container::addSubSetsFromQueryOnSubSet(), crawlservpp::Query::Container::getBoolFromQuery(), crawlservpp::Query::Container::getBoolFromQueryOnSubSet(), crawlservpp::Query::Container::getMultiFromQuery(), crawlservpp::Query::Container::getMultiFromQueryOnSubSet(), crawlservpp::Query::Container::getSingleFromQuery(), crawlservpp::Query::Container::getSingleFromQueryOnSubSet(), crawlservpp::Query::Container::nextSubSet(), crawlservpp::Query::Container::reserveForSubSets(), and crawlservpp::Query::Container::setSubSetsFromQuery().

typeXPathJsonPath

constexpr std::uint8_t crawlservpp::Struct::QueryStruct::typeXPathJsonPath {6}

inlinestatic

Query type identifying a combined XPath and JSONPath query.

Referenced by crawlservpp::Query::Container::addQuery(), crawlservpp::Query::Container::addSubSetsFromQueryOnSubSet(), crawlservpp::Query::Container::getBoolFromQuery(), crawlservpp::Query::Container::getBoolFromQueryOnSubSet(), crawlservpp::Query::Container::getMultiFromQuery(), crawlservpp::Query::Container::getMultiFromQueryOnSubSet(), crawlservpp::Query::Container::getSingleFromQuery(), crawlservpp::Query::Container::getSingleFromQueryOnSubSet(), crawlservpp::Query::Container::reserveForSubSets(), and crawlservpp::Query::Container::setSubSetsFromQuery().

typeXPathJsonPointer

constexpr std::uint8_t crawlservpp::Struct::QueryStruct::typeXPathJsonPointer {5}

inlinestatic

Query type identifying a combined XPath and JSONPointer query.

Referenced by crawlservpp::Query::Container::addQuery(), crawlservpp::Query::Container::addSubSetsFromQueryOnSubSet(), crawlservpp::Query::Container::getBoolFromQuery(), crawlservpp::Query::Container::getBoolFromQueryOnSubSet(), crawlservpp::Query::Container::getMultiFromQuery(), crawlservpp::Query::Container::getMultiFromQueryOnSubSet(), crawlservpp::Query::Container::getSingleFromQuery(), crawlservpp::Query::Container::getSingleFromQueryOnSubSet(), crawlservpp::Query::Container::reserveForSubSets(), and crawlservpp::Query::Container::setSubSetsFromQuery().

---

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

• Struct/QueryStruct.hpp