src/xmlpatterns/iterators/qdistinctiterator_p.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 //
       
    43 //  W A R N I N G
       
    44 //  -------------
       
    45 //
       
    46 // This file is not part of the Qt API.  It exists purely as an
       
    47 // implementation detail.  This header file may change from version to
       
    48 // version without notice, or even be removed.
       
    49 //
       
    50 // We mean it.
       
    51 
       
    52 #ifndef Patternist_DistinctIterator_H
       
    53 #define Patternist_DistinctIterator_H
       
    54 
       
    55 #include <QList>
       
    56 
       
    57 #include "qexpression_p.h"
       
    58 #include "qitem_p.h"
       
    59 #include "qatomiccomparator_p.h"
       
    60 #include "qcomparisonplatform_p.h"
       
    61 #include "qsourcelocationreflection_p.h"
       
    62 
       
    63 QT_BEGIN_HEADER
       
    64 
       
    65 QT_BEGIN_NAMESPACE
       
    66 
       
    67 namespace QPatternist
       
    68 {
       
    69 
       
    70     /**
       
    71      * @short Filters another sequence by removing duplicates such that the items are unique.
       
    72      *
       
    73      * DistinctIterator takes an input sequence, and returns a sequence where each
       
    74      * item is unique. Thus, DistinctIterator removes the duplicates of items
       
    75      * in a sequence. DistinctIterator is central in the implementation of the
       
    76      * <tt>fn:distinct-values()</tt> function.
       
    77      *
       
    78      * @see <a href="http://www.w3.org/TR/xpath-functions/#func-distinct-values">XQuery 1.0
       
    79      * and XPath 2.0 Functions and Operators, 15.1.6 fn:distinct-values</a>
       
    80      * @author Frans Englich <frans.englich@nokia.com>
       
    81      * @ingroup Patternist_iterators
       
    82      */
       
    83     class DistinctIterator : public Item::Iterator
       
    84                            , public ComparisonPlatform<DistinctIterator, false>
       
    85                            , public SourceLocationReflection
       
    86     {
       
    87     public:
       
    88         /**
       
    89          * Creates a DistinctIterator.
       
    90          * @param comp the AtomicComparator to be used for comparing values. This may be @c null,
       
    91          * meaning the IndexOfIterator iterator will dynamically determine what comparator to use
       
    92          * @param seq the sequence whose duplicates should be filtered out
       
    93          * @param context the usual context, used for error reporting and by AtomicComparators.
       
    94          * @param expression the Expression that this DistinctIterator is
       
    95          * evaluating for. It is used for error reporting, via
       
    96          * actualReflection().
       
    97          */
       
    98         DistinctIterator(const Item::Iterator::Ptr &seq,
       
    99                          const AtomicComparator::Ptr &comp,
       
   100                          const Expression::ConstPtr &expression,
       
   101                          const DynamicContext::Ptr &context);
       
   102 
       
   103         virtual Item next();
       
   104         virtual Item current() const;
       
   105         virtual xsInteger position() const;
       
   106         virtual Item::Iterator::Ptr copy() const;
       
   107         virtual const SourceLocationReflection *actualReflection() const;
       
   108 
       
   109         inline AtomicComparator::Operator operatorID() const
       
   110         {
       
   111             return AtomicComparator::OperatorEqual;
       
   112         }
       
   113 
       
   114     private:
       
   115         const Item::Iterator::Ptr   m_seq;
       
   116         const DynamicContext::Ptr   m_context;
       
   117         const Expression::ConstPtr  m_expr;
       
   118         Item                        m_current;
       
   119         xsInteger                   m_position;
       
   120         Item::List                  m_processed;
       
   121     };
       
   122 }
       
   123 
       
   124 QT_END_NAMESPACE
       
   125 
       
   126 QT_END_HEADER
       
   127 
       
   128 #endif