MarkLogic Connect
MarkLogic Connect Client API Collection
Public Member Functions | Protected Member Functions | List of all members
mlclient::utilities::GenericQuery Class Reference

A Generic Query concrete class for an IQuery. More...

#include <SearchBuilder.hpp>

Inheritance diagram for mlclient::utilities::GenericQuery:
mlclient::utilities::IQuery

Public Member Functions

MLCLIENT_API GenericQuery ()
 Creates a blank GenericQuery instance.
 
MLCLIENT_API void setQuery (const std::string &value)
 Sets the query from a (JSON) string value. More...
 
MLCLIENT_API const std::string & getQuery () const
 Returns the underlying query as text from this query instance. More...
 
- Public Member Functions inherited from mlclient::utilities::IQuery
MLCLIENT_API IQuery ()=default
 Default Constructor.
 
virtual MLCLIENT_API ~IQuery ()=default
 Default Destructor.
 

Protected Member Functions

std::ostream & write (std::ostream &os) const override
 

Detailed Description

A Generic Query concrete class for an IQuery.

This class is useful when you want to provide the low-level text (JSON representation of structure query configuration) rather than create a subclass for every potential IQuery instance.

Since
8.0.2

Member Function Documentation

MLCLIENT_API const std::string& mlclient::utilities::GenericQuery::getQuery ( ) const

Returns the underlying query as text from this query instance.

Returns
The string query content
MLCLIENT_API void mlclient::utilities::GenericQuery::setQuery ( const std::string &  value)

Sets the query from a (JSON) string value.

Parameters
valueThe string JSON structured query value for this query

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