File indexing completed on 2024-04-28 05:08:18

0001 /***************************************************************************
0002     Copyright (C) 2009 Robby Stephenson <robby@periapsis.org>
0003  ***************************************************************************/
0004 
0005 /***************************************************************************
0006  *                                                                         *
0007  *   This program is free software; you can redistribute it and/or         *
0008  *   modify it under the terms of the GNU General Public License as        *
0009  *   published by the Free Software Foundation; either version 2 of        *
0010  *   the License or (at your option) version 3 or any later version        *
0011  *   accepted by the membership of KDE e.V. (or its successor approved     *
0012  *   by the membership of KDE e.V.), which shall act as a proxy            *
0013  *   defined in Section 14 of version 3 of the license.                    *
0014  *                                                                         *
0015  *   This program is distributed in the hope that it will be useful,       *
0016  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
0017  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
0018  *   GNU General Public License for more details.                          *
0019  *                                                                         *
0020  *   You should have received a copy of the GNU General Public License     *
0021  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
0022  *                                                                         *
0023  ***************************************************************************/
0024 
0025 #ifndef TELLICO_ENTRYCOMPARISON_H
0026 #define TELLICO_ENTRYCOMPARISON_H
0027 
0028 #include "datavectors.h"
0029 
0030 #include <QUrl>
0031 
0032 namespace Tellico {
0033 
0034 class EntryComparison {
0035 public:
0036   /**
0037    * Set the url for comparing relative url field values
0038    * this is totally not the way the comparison should be done, but it's too expensive to include
0039    * a connection to document.h here
0040    */
0041   static void setDocumentUrl(const QUrl& url);
0042 
0043   static int score(const Data::EntryPtr& entry1, const Data::EntryPtr& entry2, Data::FieldPtr field);
0044   static int score(const Data::EntryPtr& entry1, const Data::EntryPtr& entry2, const QString& field, const Data::Collection* coll);
0045 
0046   // match scores for individual fields
0047   enum MatchValue {
0048     MATCH_VALUE_BAD    = -1,
0049     MATCH_VALUE_NONE   = 0,
0050     MATCH_VALUE_WEAK   = 3,
0051     MATCH_VALUE_STRONG = 5
0052   };
0053 
0054   // weights for which individual fields get marked
0055   enum MatchWeight {
0056     MATCH_WEIGHT_LOW  = 1,
0057     MATCH_WEIGHT_MED  = 2,
0058     MATCH_WEIGHT_HIGH = 3
0059   };
0060 
0061   // these are the total values that should be compared against
0062   // the result from Collection::sameEntry()  ../entrycomparison.cpp
0063   enum EntryMatchValue {
0064     ENTRY_BAD_MATCH     = 0,
0065     ENTRY_GOOD_MATCH    = 10,
0066     ENTRY_PERFECT_MATCH = 20
0067   };
0068 
0069 private:
0070   static QUrl s_documentUrl;
0071 };
0072 
0073 } // namespace
0074 #endif