#include "common/query.hpp"

Description

template<class RES>
class lumiera::Query< RES >

Generic interface to express a query for specifically typed result elements exposing some capabilities or fulfilling some properties.

This is a generic umbrella for several kinds of queries and provides a mechanism for uniform usage of various resolution mechanisms.

Any query bears internal type classification and can be represented in a common syntactical form based on predicate logic. Query instances are created by some facilities allowing to query for objects. These query providers do know the specific kind (type) of query to expose. While client code uses these queries only by reference, there is the possibility to involve a generic QueryResolver, which – behind the scenes – manages a registry of specific resolution mechanisms. This way, clients may retrieve a set of results, where each result represents a possible solution to the original query.

Remarks: lumiera::Query is an interface, but can be used as-is to represent a generic query. Specialised subclasses are required to provide a syntactic representation, but are free to do so only on demand. In this case, generate an empty lib::QueryText definition and implement the Query::buildSyntacticRepresentation function. Every fundamentally different kind of query needs to be listed in Goal::Kind.

Note: until we really integrate a rules based system this can be considered dummy placeholder implementation. Some more specific query resolvers are available already, so, depending on the circumstances the actual resolution might be substantial or just a fake.

Warning: especially the classical resolution-type queries are just faked and use the given query-string as-is, without any normalisation. Moreover, as especially the fake-configrules match by string comparison, this may led to unexpected mis-matches. This is dummy code, after all.

Definition at line 252 of file query.hpp.

Classes
class	Builder
	Helper for establishing, reworking and remolding queries. More...

class	Cursor

Public Types
typedef lib::IterAdapter< Cursor, PReso >	iterator

Public Types inherited from Goal
enum	Kind { EMPTY = 0 , GENERIC = 1 , DISCOVERY , PLACEMENT }

Static Public Member Functions
static Builder	build (Kind queryType=Goal::GENERIC)

Public Member Functions
	Query ()

	Query (string querySpec)

	operator QueryKey () const
	automatic conversion from Query to QueryKey for indexing and ordering.

Builder	rebuild () const

string	extractID (Symbol predicate) const
	convenience shortcut to extract a desired name-ID.

bool	usesPredicate (Symbol predicate) const

iterator	operator() (QueryResolver const &resolver) const
	notational convenience shortcut, synonymous to Query<RES>::resolveBy()

iterator	resolveBy (QueryResolver const &resolver) const

Public Member Functions inherited from Goal
virtual	~Goal ()
	this is a marker baseclass

QueryID const &	getQID () const

Friends
class	Builder

size_t	hash_value (Query const &q)

Protected Member Functions
virtual lib::QueryText	buildSyntacticRepresentation () const
	Extension point to generate a generic query definition on demand.

lib::QueryText	getQueryDefinition () const
	access the complete syntactical representation of this query.

	Query (QueryID typeID, lib::QueryText const &genericQuerySpec)

	Query (QueryID typeID, string querySpec)

Protected Member Functions inherited from Goal
	Goal (QueryID qid)

Static Protected Member Functions
static QueryID	defineQueryTypeID (Kind queryType=Goal::GENERIC)

Private Attributes
lib::QueryText	def_
	generic syntactical definition

Additional Inherited Members
Protected Attributes inherited from Goal
QueryID	id_

Constructor & Destructor Documentation

◆ Query() [1/4]

template<class RES >

Query	(	QueryID	typeID,
		lib::QueryText const &	genericQuerySpec
	)

inlineprotected

Definition at line 296 of file query.hpp.

◆ Query() [2/4]

template<class RES >

Query	(	QueryID	typeID,
		string	querySpec
	)

inlineprotected

Definition at line 301 of file query.hpp.

References Goal::getQID(), and Goal::QueryID::type.

Here is the call graph for this function:

◆ Query() [3/4]

template<class RES >

Query ( )

inline

Definition at line 312 of file query.hpp.

◆ Query() [4/4]

template<class RES >

Query ( string querySpec )

inlineexplicit

Definition at line 317 of file query.hpp.

Member Typedef Documentation

◆ iterator

template<class RES >

typedef lib::IterAdapter<Cursor,PReso> iterator

Definition at line 349 of file query.hpp.

Member Function Documentation

◆ defineQueryTypeID()

template<class RES >

static QueryID defineQueryTypeID ( Kind queryType = Goal::GENERIC )

inlinestaticprotected

Definition at line 260 of file query.hpp.

◆ buildSyntacticRepresentation()

template<class RES >

virtual lib::QueryText buildSyntacticRepresentation ( ) const

inlineprotectedvirtual

Extension point to generate a generic query definition on demand.

Some specialised kinds of queries, intended to be treated by a specific resolver, may choose skip constructing a generic query representation, but are then bound to supplement such a generic definition through this function when required. The generated query definition must be sufficient to reconstruct the query in all respects.

Returns: a complete definition of this query in predicate form

Return values

bottom token to indicate failure to comply to this requirement.

Reimplemented in ScopeQuery< MO >.

Definition at line 277 of file query.hpp.

Referenced by Query< RES >::getQueryDefinition().

Here is the caller graph for this function:

◆ getQueryDefinition()

template<class RES >

lib::QueryText getQueryDefinition ( ) const

inlineprotected

access the complete syntactical representation of this query.

May trigger on-demand initialisation

Definition at line 286 of file query.hpp.

References Query< RES >::buildSyntacticRepresentation(), and Query< RES >::def_.

Here is the call graph for this function:

◆ operator QueryKey()

template<class RES >

operator QueryKey ( ) const

inline

automatic conversion from Query to QueryKey for indexing and ordering.

By defining a parameter of type QueryKey, any provided Query will be automatically transformed into an generic representation usable for ordered storage in sets, maps and for generation of metrics.

Definition at line 585 of file query.hpp.

◆ build()

template<class RES >

Query< RES >::Builder build ( Kind queryType = Goal::GENERIC )

inlinestatic

Definition at line 542 of file query.hpp.

Referenced by QueryKey::operator Query< RES >().

Here is the caller graph for this function:

◆ rebuild()

template<class RES >

Query< RES >::Builder rebuild ( ) const

inline

Definition at line 550 of file query.hpp.

Referenced by steam::mobject::_mapping::build_corresponding_sourceQuery(), MockTable::fabricate_Sequence_on_demand(), MockTable::fabricate_Timeline_on_demand(), DefsManager::operator()(), and LookupPreconfigured::try_special_case().

Here is the caller graph for this function:

◆ extractID()

template<class RES >

string extractID ( Symbol predicate ) const

inline

convenience shortcut to extract a desired name-ID.

Todo:: used extensively for the mock implementation of query resolution. For real resolution queries, such a function is quite nonsensical. To be revisited and (likely) to be removed on the long run

See also: Query::Builder::extractID

Definition at line 564 of file query.hpp.

Referenced by StructFactoryImpl::createIdent(), MockTable::detect_case(), MockTable::detect_case(), StructFactoryImpl::fabricate(), StructFactoryImpl::fabricate(), StructFactoryImpl::fabricate(), MockTable::fabricate_Sequence_on_demand(), MockTable::fabricate_Timeline_on_demand(), and steam::mobject::_mapping::is_defaults_query_with_channel().

Here is the caller graph for this function:

◆ usesPredicate()

template<class RES >

bool usesPredicate ( Symbol predicate ) const

inline

Definition at line 572 of file query.hpp.

References lib::query::hasTerm().

Referenced by MockTable::detect_case(), and steam::mobject::session::query::anonymous_namespace{fake-configrules.hpp}::is_defaults_query().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator()()

template<typename RES >

Query< RES >::iterator operator() ( QueryResolver const & resolver ) const

inline

notational convenience shortcut, synonymous to Query<RES>::resolveBy()

Definition at line 154 of file query-resolver.hpp.

◆ resolveBy()

template<typename RES >

Query< RES >::iterator resolveBy ( QueryResolver const & resolver ) const

inline

Definition at line 141 of file query-resolver.hpp.

References QueryResolver::issue().

Referenced by PlacementIndexQuery_test::checkQueryOperations(), PlacementIndexQuery_test::checkQueryResolver(), ScopeLocator::explore(), steam::mobject::session::test::explore_testScope(), ScopeLocator::getRawPath(), ScopeQuery_test::issue(), steam::mobject::session::pickAllSuitable(), ScopeLocator::query(), steam::mobject::session::test::anonymous_namespace{test-scopes.cpp}::retrieve_firstElmOfType(), and QueryResolver_test::run().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ def_

template<class RES >

lib::QueryText def_

mutableprivate

generic syntactical definition

Definition at line 256 of file query.hpp.

Referenced by Query< RES >::getQueryDefinition().

Friends And Related Symbol Documentation

◆ Builder

template<class RES >

friend class Builder

friend

Definition at line 308 of file query.hpp.

◆ hash_value

template<class RES >

size_t hash_value ( Query< RES > const & q )

friend

Definition at line 356 of file query.hpp.

Referenced by ScopeQuery< MO >::buildSyntacticRepresentation().

Inheritance diagram for Query< RES >:

Collaboration diagram for Query< RES >:

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

Description

Classes

Public Types

Static Public Member Functions

Public Member Functions

Friends

Protected Member Functions

Static Protected Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Query() [1/4]

◆ Query() [2/4]

◆ Query() [3/4]

◆ Query() [4/4]

Member Typedef Documentation

◆ iterator

Member Function Documentation

◆ defineQueryTypeID()

◆ buildSyntacticRepresentation()

◆ getQueryDefinition()

◆ operator QueryKey()

◆ build()

◆ rebuild()

◆ extractID()

◆ usesPredicate()

◆ operator()()

◆ resolveBy()

Member Data Documentation

◆ def_

Friends And Related Symbol Documentation

◆ Builder

◆ hash_value