Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | List of all members
CDatabaseQueryRule Class Referenceabstract

#include <DatabaseQuery.h>

Inheritance diagram for CDatabaseQueryRule:
CTextureRule KODI::PLAYLIST::CSmartPlaylistRule

Public Types

enum class  SearchOperator {
  OPERATOR_START = 0 , OPERATOR_CONTAINS , OPERATOR_DOES_NOT_CONTAIN , OPERATOR_EQUALS ,
  OPERATOR_DOES_NOT_EQUAL , OPERATOR_STARTS_WITH , OPERATOR_ENDS_WITH , OPERATOR_GREATER_THAN ,
  OPERATOR_LESS_THAN , OPERATOR_AFTER , OPERATOR_BEFORE , OPERATOR_IN_THE_LAST ,
  OPERATOR_NOT_IN_THE_LAST , OPERATOR_TRUE , OPERATOR_FALSE , OPERATOR_BETWEEN ,
  OPERATOR_END
}
 
enum class  FieldType {
  TEXT_FIELD = 0 , REAL_FIELD , NUMERIC_FIELD , DATE_FIELD ,
  PLAYLIST_FIELD , SECONDS_FIELD , BOOLEAN_FIELD , TEXTIN_FIELD
}
 

Public Member Functions

 CDatabaseQueryRule ()=default
 
virtual ~CDatabaseQueryRule ()=default
 
virtual bool Load (const TiXmlNode *node, const std::string &encoding="UTF-8")
 
virtual bool Load (const CVariant &obj)
 
virtual bool Save (TiXmlNode *parent) const
 
virtual bool Save (CVariant &obj) const
 
std::string GetParameter () const
 
void SetParameter (const std::string &value)
 
void SetParameter (const std::vector< std::string > &values)
 
virtual std::string GetWhereClause (const CDatabase &db, const std::string &strType) const
 

Static Public Member Functions

static std::string GetLocalizedOperator (SearchOperator oper)
 
static void GetAvailableOperators (std::vector< std::string > &operatorList)
 

Public Attributes

int m_field {0}
 
SearchOperator m_operator {SearchOperator::OPERATOR_CONTAINS}
 
std::vector< std::string > m_parameter
 

Protected Member Functions

virtual std::string GetField (int field, const std::string &type) const =0
 
virtual CDatabaseQueryRule::FieldType GetFieldType (int field) const =0
 
virtual int TranslateField (const char *field) const =0
 
virtual std::string TranslateField (int field) const =0
 
std::string ValidateParameter (const std::string &parameter) const
 
virtual std::string FormatParameter (const std::string &negate, const std::string &oper, const CDatabase &db, const std::string &type) const
 
virtual std::string FormatWhereClause (const std::string &negate, const std::string &oper, const std::string &param, const CDatabase &db, const std::string &type) const
 
virtual SearchOperator GetOperator (const std::string &type) const
 
virtual std::string GetOperatorString (SearchOperator op) const
 
virtual std::string GetBooleanQuery (const std::string &negate, const std::string &strType) const
 

Static Protected Member Functions

static SearchOperator TranslateOperator (const char *oper)
 
static std::string TranslateOperator (SearchOperator oper)
 

Member Enumeration Documentation

◆ FieldType

enum class CDatabaseQueryRule::FieldType
strong
Enumerator
TEXT_FIELD 
REAL_FIELD 
NUMERIC_FIELD 
DATE_FIELD 
PLAYLIST_FIELD 
SECONDS_FIELD 
BOOLEAN_FIELD 
TEXTIN_FIELD 

◆ SearchOperator

enum class CDatabaseQueryRule::SearchOperator
strong
Enumerator
OPERATOR_START 
OPERATOR_CONTAINS 
OPERATOR_DOES_NOT_CONTAIN 
OPERATOR_EQUALS 
OPERATOR_DOES_NOT_EQUAL 
OPERATOR_STARTS_WITH 
OPERATOR_ENDS_WITH 
OPERATOR_GREATER_THAN 
OPERATOR_LESS_THAN 
OPERATOR_AFTER 
OPERATOR_BEFORE 
OPERATOR_IN_THE_LAST 
OPERATOR_NOT_IN_THE_LAST 
OPERATOR_TRUE 
OPERATOR_FALSE 
OPERATOR_BETWEEN 
OPERATOR_END 

Constructor & Destructor Documentation

◆ CDatabaseQueryRule()

CDatabaseQueryRule::CDatabaseQueryRule ( )
default

◆ ~CDatabaseQueryRule()

virtual CDatabaseQueryRule::~CDatabaseQueryRule ( )
virtualdefault

Member Function Documentation

◆ FormatParameter()

std::string CDatabaseQueryRule::FormatParameter ( const std::string & negate,
const std::string & oper,
const CDatabase & db,
const std::string & type ) const
protectedvirtual

Reimplemented in CTextureRule, and KODI::PLAYLIST::CSmartPlaylistRule.

◆ FormatWhereClause()

std::string CDatabaseQueryRule::FormatWhereClause ( const std::string & negate,
const std::string & oper,
const std::string & param,
const CDatabase & db,
const std::string & type ) const
protectedvirtual

Reimplemented in KODI::PLAYLIST::CSmartPlaylistRule.

◆ GetAvailableOperators()

void CDatabaseQueryRule::GetAvailableOperators ( std::vector< std::string > & operatorList)
static

◆ GetBooleanQuery()

virtual std::string CDatabaseQueryRule::GetBooleanQuery ( const std::string & negate,
const std::string & strType ) const
inlineprotectedvirtual

Reimplemented in KODI::PLAYLIST::CSmartPlaylistRule.

◆ GetField()

virtual std::string CDatabaseQueryRule::GetField ( int field,
const std::string & type ) const
protectedpure virtual

Implemented in CTextureRule, and KODI::PLAYLIST::CSmartPlaylistRule.

◆ GetFieldType()

virtual CDatabaseQueryRule::FieldType CDatabaseQueryRule::GetFieldType ( int field) const
protectedpure virtual

Implemented in CTextureRule, and KODI::PLAYLIST::CSmartPlaylistRule.

◆ GetLocalizedOperator()

std::string CDatabaseQueryRule::GetLocalizedOperator ( SearchOperator oper)
static

◆ GetOperator()

virtual SearchOperator CDatabaseQueryRule::GetOperator ( const std::string & type) const
inlineprotectedvirtual

Reimplemented in KODI::PLAYLIST::CSmartPlaylistRule.

◆ GetOperatorString()

std::string CDatabaseQueryRule::GetOperatorString ( SearchOperator op) const
protectedvirtual

◆ GetParameter()

std::string CDatabaseQueryRule::GetParameter ( ) const

◆ GetWhereClause()

std::string CDatabaseQueryRule::GetWhereClause ( const CDatabase & db,
const std::string & strType ) const
virtual

◆ Load() [1/2]

bool CDatabaseQueryRule::Load ( const CVariant & obj)
virtual

◆ Load() [2/2]

bool CDatabaseQueryRule::Load ( const TiXmlNode * node,
const std::string & encoding = "UTF-8" )
virtual

◆ Save() [1/2]

bool CDatabaseQueryRule::Save ( CVariant & obj) const
virtual

◆ Save() [2/2]

bool CDatabaseQueryRule::Save ( TiXmlNode * parent) const
virtual

◆ SetParameter() [1/2]

void CDatabaseQueryRule::SetParameter ( const std::string & value)

◆ SetParameter() [2/2]

void CDatabaseQueryRule::SetParameter ( const std::vector< std::string > & values)

◆ TranslateField() [1/2]

virtual int CDatabaseQueryRule::TranslateField ( const char * field) const
protectedpure virtual

Implemented in CTextureRule, and KODI::PLAYLIST::CSmartPlaylistRule.

◆ TranslateField() [2/2]

virtual std::string CDatabaseQueryRule::TranslateField ( int field) const
protectedpure virtual

Implemented in CTextureRule, and KODI::PLAYLIST::CSmartPlaylistRule.

◆ TranslateOperator() [1/2]

CDatabaseQueryRule::SearchOperator CDatabaseQueryRule::TranslateOperator ( const char * oper)
staticprotected

◆ TranslateOperator() [2/2]

std::string CDatabaseQueryRule::TranslateOperator ( SearchOperator oper)
staticprotected

◆ ValidateParameter()

std::string CDatabaseQueryRule::ValidateParameter ( const std::string & parameter) const
protected

Member Data Documentation

◆ m_field

int CDatabaseQueryRule::m_field {0}

◆ m_operator

SearchOperator CDatabaseQueryRule::m_operator {SearchOperator::OPERATOR_CONTAINS}

◆ m_parameter

std::vector<std::string> CDatabaseQueryRule::m_parameter
The documentation for this class was generated from the following files: