• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

Nepomuk

  • nepomuk
  • query
comparisonterm.h
Go to the documentation of this file.
1/*
2 This file is part of the Nepomuk KDE project.
3 Copyright (C) 2009-2010 Sebastian Trueg <trueg@kde.org>
4
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) version 3, or any
9 later version accepted by the membership of KDE e.V. (or its
10 successor approved by the membership of KDE e.V.), which shall
11 act as a proxy defined in Section 6 of version 3 of the license.
12
13 This library is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
17
18 You should have received a copy of the GNU Lesser General Public
19 License along with this library. If not, see <http://www.gnu.org/licenses/>.
20*/
21
22#ifndef _NEPOMUK_QUERY_COMPARISON_TERM_H_
23#define _NEPOMUK_QUERY_COMPARISON_TERM_H_
24
25#include "simpleterm.h"
26
27#include "nepomukquery_export.h"
28
29namespace Nepomuk {
30 namespace Types {
31 class Property;
32 }
33
34 namespace Query {
70 class NEPOMUKQUERY_EXPORT ComparisonTerm : public SimpleTerm
71 {
72 public:
76 enum Comparator {
81 Contains,
82
89 Regexp,
90
94 Equal,
95
99 Greater,
100
104 Smaller,
105
109 GreaterOrEqual,
110
114 SmallerOrEqual
115 };
116
125 enum AggregateFunction {
129 NoAggregateFunction = 0,
130
137 Count,
138
143 DistinctCount,
144
150 Max,
151
157 Min,
158
164 Sum,
165
170 DistinctSum,
171
177 Average,
178
183 DistinctAverage
184 };
185
189 ComparisonTerm();
190
194 ComparisonTerm( const ComparisonTerm& term );
195
204 ComparisonTerm( const Types::Property& property, const Term& term, Comparator comparator = Contains );
205
209 ~ComparisonTerm();
210
214 ComparisonTerm& operator=( const ComparisonTerm& term );
215
221 Comparator comparator() const;
222
229 Types::Property property() const;
230
234 void setComparator( Comparator );
235
242 void setProperty( const Types::Property& );
243
287 void setVariableName( const QString& name );
288
297 QString variableName() const;
298
309 void setAggregateFunction( AggregateFunction function );
310
319 AggregateFunction aggregateFunction() const;
320
341 void setSortWeight( int weight, Qt::SortOrder sortOrder = Qt::AscendingOrder );
342
349 int sortWeight() const;
350
356 Qt::SortOrder sortOrder() const;
357
364 bool isInverted() const;
365
394 void setInverted( bool invert );
395
414 ComparisonTerm inverted() const;
415 };
416 }
417}
418
419#endif
Nepomuk::Query::ComparisonTerm
A term matching the value of a property.
Definition: comparisonterm.h:71
Nepomuk::Query::ComparisonTerm::ComparisonTerm
ComparisonTerm(const ComparisonTerm &term)
Copy constructor.
Nepomuk::Query::ComparisonTerm::ComparisonTerm
ComparisonTerm()
Default constructor: creates a comparison term that matches all properties.
Nepomuk::Query::ComparisonTerm::property
Types::Property property() const
A property used for ComparisonTerm Terms.
Nepomuk::Query::ComparisonTerm::setVariableName
void setVariableName(const QString &name)
Set the variable name that is to be used for the variable to match to.
Nepomuk::Query::ComparisonTerm::aggregateFunction
AggregateFunction aggregateFunction() const
The aggregate function to be used with the additional binding set in setVariableName().
Nepomuk::Query::ComparisonTerm::operator=
ComparisonTerm & operator=(const ComparisonTerm &term)
Assignment operator.
Nepomuk::Query::ComparisonTerm::Comparator
Comparator
ComparisonTerm supports different ways to compare values.
Definition: comparisonterm.h:76
Nepomuk::Query::ComparisonTerm::Contains
@ Contains
A LiteralTerm sub-term is matched against string literal values.
Definition: comparisonterm.h:81
Nepomuk::Query::ComparisonTerm::Regexp
@ Regexp
A LiteralTerm sub-term is matched against a string literal value using the literal term's value as a ...
Definition: comparisonterm.h:89
Nepomuk::Query::ComparisonTerm::Equal
@ Equal
A sub-term is matched one-to-one.
Definition: comparisonterm.h:94
Nepomuk::Query::ComparisonTerm::GreaterOrEqual
@ GreaterOrEqual
A LiteralTerm sub-term is matched to greater or equal literal values.
Definition: comparisonterm.h:109
Nepomuk::Query::ComparisonTerm::Greater
@ Greater
A LiteralTerm sub-term is matched to greater literal values.
Definition: comparisonterm.h:99
Nepomuk::Query::ComparisonTerm::Smaller
@ Smaller
A LiteralTerm sub-term is matched to smaller literal values.
Definition: comparisonterm.h:104
Nepomuk::Query::ComparisonTerm::comparator
Comparator comparator() const
The Comparator used by ComparisonTerm Terms.
Nepomuk::Query::ComparisonTerm::ComparisonTerm
ComparisonTerm(const Types::Property &property, const Term &term, Comparator comparator=Contains)
Convinience constructor which covers most simple use cases.
Nepomuk::Query::ComparisonTerm::setComparator
void setComparator(Comparator)
Set the comparator.
Nepomuk::Query::ComparisonTerm::AggregateFunction
AggregateFunction
Aggregate functions which can be applied to a comparison term to influence the value they return.
Definition: comparisonterm.h:125
Nepomuk::Query::ComparisonTerm::Sum
@ Sum
Return the sum of all result values instead of the results themselves.
Definition: comparisonterm.h:164
Nepomuk::Query::ComparisonTerm::Min
@ Min
Return the minimum value of all results instead of the results themselves.
Definition: comparisonterm.h:157
Nepomuk::Query::ComparisonTerm::DistinctCount
@ DistinctCount
The same as Count except that no two similar results are counted twice.
Definition: comparisonterm.h:143
Nepomuk::Query::ComparisonTerm::Average
@ Average
Return the average value of all results instead of the results themselves.
Definition: comparisonterm.h:177
Nepomuk::Query::ComparisonTerm::DistinctSum
@ DistinctSum
The same as Sum except that no two similar results are added twice.
Definition: comparisonterm.h:170
Nepomuk::Query::ComparisonTerm::Max
@ Max
Return the maximum value of all results instead of the results themselves.
Definition: comparisonterm.h:150
Nepomuk::Query::ComparisonTerm::Count
@ Count
Count the number of matching results instead of returning the results themselves.
Definition: comparisonterm.h:137
Nepomuk::Query::ComparisonTerm::~ComparisonTerm
~ComparisonTerm()
Destructor.
Nepomuk::Query::ComparisonTerm::inverted
ComparisonTerm inverted() const
Create an inverted copy of this ComparisonTerm.
Nepomuk::Query::ComparisonTerm::setInverted
void setInverted(bool invert)
Invert the comparison, i.e.
Nepomuk::Query::ComparisonTerm::sortOrder
Qt::SortOrder sortOrder() const
Nepomuk::Query::ComparisonTerm::setSortWeight
void setSortWeight(int weight, Qt::SortOrder sortOrder=Qt::AscendingOrder)
Set the sort weight of this property.
Nepomuk::Query::ComparisonTerm::isInverted
bool isInverted() const
Nepomuk::Query::ComparisonTerm::variableName
QString variableName() const
The variable name set in setVariableName() or an empty string if none has been set.
Nepomuk::Query::ComparisonTerm::setAggregateFunction
void setAggregateFunction(AggregateFunction function)
Set an aggregate function which changes the result.
Nepomuk::Query::ComparisonTerm::setProperty
void setProperty(const Types::Property &)
Set the property for ComparisonTerm Terms.
Nepomuk::Query::ComparisonTerm::sortWeight
int sortWeight() const
Nepomuk::Query::SimpleTerm
Abstract base class for NegationTerm and ComparisonTerm which maintains one sub-term.
Definition: simpleterm.h:42
Nepomuk::Query::Term
The base class for all term types.
Definition: term.h:65
Nepomuk::Types::Property
A property is a resource of type rdf:Property which relates a domain with a range.
Definition: property.h:53
Nepomuk
nepomukquery_export.h
simpleterm.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Nepomuk

Skip menu "Nepomuk"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal