r_OQL_Query Class Reference

The global function r_oql_execute() is used to invoke RasML queries. More...

#include <oqlquery.hh>

Public Member Functions
	r_OQL_Query ()=default
	default constructor
	r_OQL_Query (const char *s)
	constructor getting the query string
	r_OQL_Query (const r_OQL_Query &q)
	copy constructor
	~r_OQL_Query ()
	destructor
const r_OQL_Query &	operator= (const r_OQL_Query &q)
	assignment operator
r_OQL_Query &	operator<< (const char *s)
r_OQL_Query &	operator<< (r_Char c)
r_OQL_Query &	operator<< (r_Short s)
r_OQL_Query &	operator<< (r_UShort us)
r_OQL_Query &	operator<< (r_Long l)
r_OQL_Query &	operator<< (r_ULong ul)
r_OQL_Query &	operator<< (r_Point pt)
r_OQL_Query &	operator<< (r_Sinterval in)
r_OQL_Query &	operator<< (r_Minterval in)
r_OQL_Query &	operator<< (r_GMarray &in)
int	is_update_query () const
	returns true if the current query is an update / delete one
int	is_insert_query () const
	returns true if the current query is an insert one
int	is_retrieval_query () const
	returns true if the current query is an retrieval query (select)
void	reset_query ()
	resets the expandation of the query string
const char *	get_query () const
	gets the expanded query string
const r_Set< r_GMarray * > *	get_constants () const
	get mdd constants
const char *	get_parameterized_query () const
	gets the parameterized query string

Detailed Description

The global function r_oql_execute() is used to invoke RasML queries.

The query statement is represented through an object of class r_OQL_Query which is the first argument of the function. The constructor gets a parameterized query string where $i indicates the i-th parameter. The overloaded stream input operators allows to insert the parameter values to the query, at the same time preserving their respective types. If any of the $i are not followed by a right operant construction argument at the point r_oql_execute is called, a r_Error exception object of kind r_Error_QueryParameterCountInvalid is thrown. Once a query has been executed via r_oql_execute(), the arguments associated with the $i parameters are cleared and new arguments must be supplied.

The copy constructor and assignment operator copy all the underlying data structures associated with the query, based upon the parameters that have been passed to the query at the point the operation is performed.

The stream operators raise a r_Error exception of type r_Error_QueryParameterCountInvalid if the number of arguments is exceeded.

Constructor & Destructor Documentation

r_OQL_Query() [1/3]

r_OQL_Query::r_OQL_Query ( )

default

default constructor

r_OQL_Query() [2/3]

r_OQL_Query::r_OQL_Query ( const char *  s )

explicit

constructor getting the query string

r_OQL_Query() [3/3]

r_OQL_Query::r_OQL_Query

(

const r_OQL_Query &

q

)

copy constructor

~r_OQL_Query()

r_OQL_Query::~r_OQL_Query

(

)

destructor

Member Function Documentation

get_constants()

const r_Set< r_GMarray * > * r_OQL_Query::get_constants

(

)

const

get mdd constants

get_parameterized_query()

const char * r_OQL_Query::get_parameterized_query

(

)

const

gets the parameterized query string

get_query()

const char * r_OQL_Query::get_query

(

)

const

gets the expanded query string

is_insert_query()

int r_OQL_Query::is_insert_query

(

)

const

returns true if the current query is an insert one

is_retrieval_query()

int r_OQL_Query::is_retrieval_query

(

)

const

returns true if the current query is an retrieval query (select)

is_update_query()

int r_OQL_Query::is_update_query

(

)

const

returns true if the current query is an update / delete one

operator<<() [1/10]

r_OQL_Query & r_OQL_Query::operator<<

(

const char *

s

)

operator<<() [2/10]

r_OQL_Query & r_OQL_Query::operator<<

(

r_Char

c

)

operator<<() [3/10]

r_OQL_Query & r_OQL_Query::operator<<

(

r_GMarray &

in

)

operator<<() [4/10]

r_OQL_Query & r_OQL_Query::operator<<

(

r_Long

l

)

operator<<() [5/10]

r_OQL_Query & r_OQL_Query::operator<<

(

r_Minterval

in

)

operator<<() [6/10]

r_OQL_Query & r_OQL_Query::operator<<

(

r_Point

pt

)

operator<<() [7/10]

r_OQL_Query & r_OQL_Query::operator<<

(

r_Short

s

)

operator<<() [8/10]

r_OQL_Query & r_OQL_Query::operator<<

(

r_Sinterval

in

)

operator<<() [9/10]

r_OQL_Query & r_OQL_Query::operator<<

(

r_ULong

ul

)

operator<<() [10/10]

r_OQL_Query & r_OQL_Query::operator<<

(

r_UShort

us

)

operator=()

const r_OQL_Query & r_OQL_Query::operator=

(

const r_OQL_Query &

q

)

assignment operator

reset_query()

void r_OQL_Query::reset_query

(

)

resets the expandation of the query string

---

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

• oqlquery.hh