~ubuntu-branches/ubuntu/gutsy/soprano/gutsy

« back to all changes in this revision

Viewing changes to index/clucenedocumentwrapper.h

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Riddell
  • Date: 2007-10-12 14:43:48 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20071012144348-yajzi51v4k23ahxf
Tags: 1.95.0~beta2-1ubuntu1
* Sync with Debian
* Add versioned build-dep on raptor

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
 * This file is part of Soprano Project.
 
3
 *
 
4
 * Copyright (C) 2007 Sebastian Trueg <trueg@kde.org>
 
5
 *
 
6
 * This library is free software; you can redistribute it and/or
 
7
 * modify it under the terms of the GNU Library General Public
 
8
 * License as published by the Free Software Foundation; either
 
9
 * version 2 of the License, or (at your option) any later version.
 
10
 *
 
11
 * This library is distributed in the hope that it will be useful,
 
12
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
14
 * Library General Public License for more details.
 
15
 *
 
16
 * You should have received a copy of the GNU Library General Public License
 
17
 * along with this library; see the file COPYING.LIB.  If not, write to
 
18
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 
19
 * Boston, MA 02110-1301, USA.
 
20
 */
 
21
 
 
22
#ifndef _SOPRANO_CLUCENE_DOCUMENT_WRAPPER_H_
 
23
#define _SOPRANO_CLUCENE_DOCUMENT_WRAPPER_H_
 
24
 
 
25
#include <QtCore/QString>
 
26
 
 
27
 
 
28
namespace lucene {
 
29
    namespace document {
 
30
        class Document;
 
31
    }
 
32
    namespace index {
 
33
        class IndexWriter;
 
34
    }
 
35
}
 
36
 
 
37
class TString;
 
38
 
 
39
namespace Soprano {
 
40
    namespace Index {
 
41
        /**
 
42
         * Transparently handles adding of properties to a CLucene
 
43
         * Document.
 
44
         */
 
45
        class CLuceneDocumentWrapper
 
46
        {
 
47
        public:
 
48
            CLuceneDocumentWrapper( lucene::document::Document* );
 
49
            ~CLuceneDocumentWrapper();
 
50
 
 
51
            void addProperty( const TString& field, const TString& text );
 
52
            void removeProperty( const TString& field, const TString& text );
 
53
        
 
54
            /**
 
55
             * Checks whether a field occurs with a specified value in a Document.
 
56
             */
 
57
            bool hasProperty( const QString& field, const QString& text ) const;
 
58
 
 
59
            /**
 
60
             * Determines the number of properties stored in a Document.
 
61
             */
 
62
            int numberOfPropertyFields() const;
 
63
 
 
64
            /**
 
65
             * Stores and indexes an ID in a Document.
 
66
             */
 
67
            void addID( const QString& id );
 
68
 
 
69
            void save( lucene::index::IndexWriter* );
 
70
 
 
71
        private:
 
72
            class Private;
 
73
            Private* const d;
 
74
        };
 
75
    }
 
76
}
 
77
 
 
78
#endif