LibreOffice Module filter (master) 1
Public Member Functions | Private Attributes | List of all members
filter::config::QueryTokenizer Class Reference

It can be used to split any query string (which can be used at the related interface <type scope="css::container">XContainerQuery</type>) into its different tokens using a fix schema. More...

#include <querytokenizer.hxx>

Inheritance diagram for filter::config::QueryTokenizer:
[legend]
Collaboration diagram for filter::config::QueryTokenizer:
[legend]

Public Member Functions

 QueryTokenizer (std::u16string_view sQuery)
 create a new tokenizer instance with a a new query. More...
 
virtual ~QueryTokenizer ()
 destruct an instance of this class. More...
 
bool valid () const
 can be used to check if analyzing of given query was successful or not. More...
 

Private Attributes

bool m_bValid
 Because the given query can contain errors, it should be checked outside. More...
 

Detailed Description

It can be used to split any query string (which can be used at the related interface <type scope="css::container">XContainerQuery</type>) into its different tokens using a fix schema.

@descr All queries implemented of the services

uses this schema.

Attention: \n This class is not threadsafe implemented. Because it's not necessary.
But you have to make sure that it's not used as such :-)

Definition at line 46 of file querytokenizer.hxx.

Constructor & Destructor Documentation

◆ QueryTokenizer()

filter::config::QueryTokenizer::QueryTokenizer ( std::u16string_view  sQuery)
explicit

create a new tokenizer instance with a a new query.

@descr The given query is immediately analyzed and separated into its token, which can be access by some specialized method later.

Parameters
sQuerythe query string.

Definition at line 29 of file querytokenizer.cxx.

References end, find(), o3tl::getToken(), and m_bValid.

◆ ~QueryTokenizer()

filter::config::QueryTokenizer::~QueryTokenizer ( )
virtual

destruct an instance of this class.

Definition at line 56 of file querytokenizer.cxx.

Member Function Documentation

◆ valid()

bool filter::config::QueryTokenizer::valid ( ) const

can be used to check if analyzing of given query was successful or not.

Definition at line 62 of file querytokenizer.cxx.

References m_bValid.

Referenced by filter::config::FilterFactory::createSubSetEnumerationByQuery().

Member Data Documentation

◆ m_bValid

bool filter::config::QueryTokenizer::m_bValid
private

Because the given query can contain errors, it should be checked outside.

TODO May it's a good idea to describe the real problem more detailed ...

Definition at line 59 of file querytokenizer.hxx.

Referenced by QueryTokenizer(), and valid().


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