Lucene++ - a full-featured, c++ search engine
API Documentation


DocIdBitSet.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2014 Alan Wright. All rights reserved.
3 // Distributable under the terms of either the Apache License (Version 2.0)
4 // or the GNU Lesser General Public License.
6 
7 #ifndef DOCIDBITSET_H
8 #define DOCIDBITSET_H
9 
10 #include "DocIdSet.h"
11 
12 namespace Lucene {
13 
15 class LPPAPI DocIdBitSet : public DocIdSet {
16 public:
18  DocIdBitSet(const BitSetPtr& bitSet);
19 
20  virtual ~DocIdBitSet();
21 
23 
24 protected:
26 
27 public:
29 
31  virtual bool isCacheable();
32 
35 
36  virtual bool equals(const LuceneObjectPtr& other);
37  virtual int32_t hashCode();
39 };
40 
41 }
42 
43 #endif
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Simple DocIdSet and DocIdSetIterator backed by a BitSet.
Definition: DocIdBitSet.h:15
DocIdBitSet(const BitSetPtr &bitSet)
virtual bool isCacheable()
This DocIdSet implementation is cacheable.
virtual ~DocIdBitSet()
virtual DocIdSetIteratorPtr iterator()
Provides a DocIdSetIterator to access the set. This implementation can return null or EmptyDocIdSet....
BitSetPtr getBitSet()
Returns the underlying BitSet.
BitSetPtr bitSet
Definition: DocIdBitSet.h:22
virtual bool equals(const LuceneObjectPtr &other)
Return whether two objects are equal.
virtual LuceneObjectPtr clone(const LuceneObjectPtr &other=LuceneObjectPtr())
Return clone of this object.
virtual int32_t hashCode()
Return hash code for this object.
A DocIdSet contains a set of doc ids. Implementing classes must only implement iterator to provide ac...
Definition: DocIdSet.h:16
Definition: AbstractAllTermDocs.h:12
boost::shared_ptr< LuceneObject > LuceneObjectPtr
Definition: LuceneTypes.h:539
boost::shared_ptr< DocIdSetIterator > DocIdSetIteratorPtr
Definition: LuceneTypes.h:324
boost::shared_ptr< BitSet > BitSetPtr
Definition: LuceneTypes.h:522

clucene.sourceforge.net