source: branches/vendor/trolltech/qt/current/tools/assistant/lib/qhelpsearchindexwriter_clucene_p.h @ 2

Last change on this file since 2 was 2, checked in by Dmitry A. Kuminov, 13 years ago

Initially imported qt-all-opensource-src-4.5.1 from Trolltech.

File size: 3.9 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** Contact: Qt Software Information (qt-info@nokia.com)
5**
6** This file is part of the Qt Assistant of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial Usage
10** Licensees holding valid Qt Commercial licenses may use this file in
11** accordance with the Qt Commercial License Agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Nokia.
14**
15** GNU Lesser General Public License Usage
16** Alternatively, this file may be used under the terms of the GNU Lesser
17** General Public License version 2.1 as published by the Free Software
18** Foundation and appearing in the file LICENSE.LGPL included in the
19** packaging of this file.  Please review the following information to
20** ensure the GNU Lesser General Public License version 2.1 requirements
21** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22**
23** In addition, as a special exception, Nokia gives you certain
24** additional rights. These rights are described in the Nokia Qt LGPL
25** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26** package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file.  Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you are unsure which license is appropriate for your use, please
37** contact the sales department at qt-sales@nokia.com.
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#ifndef QHELPSEARCHINDEXWRITERCLUCENE_H
43#define QHELPSEARCHINDEXWRITERCLUCENE_H
44
45//
46//  W A R N I N G
47//  -------------
48//
49// This file is not part of the Qt API. It exists for the convenience
50// of the help generator tools. This header file may change from version
51// to version without notice, or even be removed.
52//
53// We mean it.
54//
55
56#include "qhelpenginecore.h"
57#include "fulltextsearch/qanalyzer_p.h"
58
59#include <QtCore/QUrl>
60#include <QtCore/QThread>
61#include <QtCore/QMutex>
62#include <QtCore/QObject>
63#include <QtCore/QString>
64#include <QtCore/QDateTime>
65#include <QtCore/QStringList>
66#include <QtCore/QWaitCondition>
67
68QT_BEGIN_NAMESPACE
69
70class QCLuceneIndexWriter;
71
72namespace qt {
73    namespace fulltextsearch {
74        namespace clucene {
75
76class QHelpSearchIndexWriter : public QThread
77{
78    Q_OBJECT
79
80public:
81    QHelpSearchIndexWriter();
82    ~QHelpSearchIndexWriter();
83
84    void cancelIndexing();
85    void updateIndex(const QString &collectionFile,
86        const QString &indexFilesFolder, bool reindex);
87    void optimizeIndex();
88
89signals:
90    void indexingStarted();
91    void indexingFinished();
92
93private:
94    void run();
95
96    bool addDocuments(const QList<QUrl> docFiles, const QHelpEngineCore &engine,
97        const QStringList &attributes, const QString &namespaceName,
98        QCLuceneIndexWriter *writer, QCLuceneAnalyzer &analyzer);
99    void removeDocuments(const QString &indexPath, const QString &namespaceName);
100
101    bool writeIndexMap(QHelpEngineCore& engine,
102        const QMap<QString, QDateTime>& indexMap);
103
104    QList<QUrl> indexableFiles(QHelpEngineCore *helpEngine,
105        const QString &namespaceName, const QStringList &attributes) const;
106
107private:
108    QMutex mutex;
109    QWaitCondition waitCondition;
110
111    bool m_cancel;
112    bool m_reindex;
113    QString m_collectionFile;
114    QString m_indexFilesFolder;
115};
116
117        }   // namespace clucene
118    }   // namespace fulltextsearch
119}   // namespace clucene
120
121QT_END_NAMESPACE
122
123#endif  // QHELPSEARCHINDEXWRITERCLUCENE_H
Note: See TracBrowser for help on using the repository browser.