comparisonterm.h

Go to the documentation of this file.

/*
   This file is part of the Nepomuk KDE project.
   Copyright (C) 2009-2010 Sebastian Trueg <trueg@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) version 3, or any
   later version accepted by the membership of KDE e.V. (or its
   successor approved by the membership of KDE e.V.), which shall
   act as a proxy defined in Section 6 of version 3 of the license.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef _NEPOMUK2_QUERY_COMPARISON_TERM_H_
#define _NEPOMUK2_QUERY_COMPARISON_TERM_H_

#include "simpleterm.h"

#include "nepomuk_export.h"

namespace Nepomuk2 {
    namespace Types {
        class Property;
    }

    namespace Query {
        class NEPOMUK_EXPORT ComparisonTerm : public SimpleTerm
        {
        public:
            enum Comparator {
                Contains,

                Regexp,

                Equal,

                Greater,

                Smaller,

                GreaterOrEqual,

                SmallerOrEqual
            };

            enum AggregateFunction {
                NoAggregateFunction = 0,

                Count,

                DistinctCount,

                Max,

                Min,

                Sum,

                DistinctSum,

                Average,

                DistinctAverage
            };

            ComparisonTerm();

            ComparisonTerm( const ComparisonTerm& term );

            ComparisonTerm( const Types::Property& property, const Term& term, Comparator comparator = Contains );

            ~ComparisonTerm();

            ComparisonTerm& operator=( const ComparisonTerm& term );

            Comparator comparator() const;

            Types::Property property() const;

            void setComparator( Comparator );

            void setProperty( const Types::Property& );

            void setVariableName( const QString& name );

            QString variableName() const;

            void setAggregateFunction( AggregateFunction function );

            AggregateFunction aggregateFunction() const;

            void setSortWeight( int weight, Qt::SortOrder sortOrder = Qt::AscendingOrder );

            int sortWeight() const;

            Qt::SortOrder sortOrder() const;

            bool isInverted() const;

            void setInverted( bool invert );

            ComparisonTerm inverted() const;
        };
    }
}

#endif