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

Loading...
Searching...
No Matches
DocIdSet.h
Go to the documentation of this file.
1
2// 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 DOCIDSET_H
8#define DOCIDSET_H
9
10#include "DocIdSetIterator.h"
11
12 namespace Lucene {
13
16 class LPPAPI DocIdSet : public LuceneObject {
17 public:
18 virtual ~DocIdSet();
19 LUCENE_CLASS(DocIdSet);
20
21 public:
24 virtual DocIdSetIteratorPtr iterator() = 0;
25
30 virtual bool isCacheable();
31
33 static DocIdSetPtr EMPTY_DOCIDSET();
34};
35
36}
37
38#endif
DocIdSetIterator.h
LUCENE_CLASS
#define LUCENE_CLASS(Name)
Definition LuceneObject.h:24
Lucene::DocIdSet
A DocIdSet contains a set of doc ids. Implementing classes must only implement iterator to provide ac...
Definition DocIdSet.h:16
Lucene::DocIdSet::iterator
virtual DocIdSetIteratorPtr iterator()=0
Provides a DocIdSetIterator to access the set. This implementation can return null or EmptyDocIdSet....
Lucene::DocIdSet::EMPTY_DOCIDSET
static DocIdSetPtr EMPTY_DOCIDSET()
An empty {.
Lucene::DocIdSet::isCacheable
virtual bool isCacheable()
This method is a hint for CachingWrapperFilter, if this DocIdSet should be cached without copying it ...
Lucene::DocIdSet::~DocIdSet
virtual ~DocIdSet()
Lucene::LuceneObject
Base class for all Lucene classes.
Definition LuceneObject.h:31
Lucene
Definition AbstractAllTermDocs.h:12
Lucene::DocIdSetPtr
boost::shared_ptr< DocIdSet > DocIdSetPtr
Definition LuceneTypes.h:323
Lucene::DocIdSetIteratorPtr
boost::shared_ptr< DocIdSetIterator > DocIdSetIteratorPtr
Definition LuceneTypes.h:324

clucene.sourceforge.net