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


SpanQueryFilter.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 SPANQUERYFILTER_H
8 #define SPANQUERYFILTER_H
9 
10 #include "SpanFilter.h"
11 
12 namespace Lucene {
13 
20 class LPPAPI SpanQueryFilter : public SpanFilter {
21 public:
25 
26  virtual ~SpanQueryFilter();
27 
29 
30 protected:
32 
33 public:
34  virtual DocIdSetPtr getDocIdSet(const IndexReaderPtr& reader);
36 
38 
39  virtual String toString();
40  virtual bool equals(const LuceneObjectPtr& other);
41  virtual int32_t hashCode();
42 };
43 
44 }
45 
46 #endif
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Abstract base class providing a mechanism to restrict searches to a subset of an index and also maint...
Definition: SpanFilter.h:21
Constrains search results to only match those which also match a provided query. Also provides positi...
Definition: SpanQueryFilter.h:20
SpanQueryPtr getQuery()
virtual String toString()
Returns a string representation of the object.
virtual bool equals(const LuceneObjectPtr &other)
Return whether two objects are equal.
virtual int32_t hashCode()
Return hash code for this object.
SpanQueryFilter(const SpanQueryPtr &query=SpanQueryPtr())
Constructs a filter which only matches documents matching query.
SpanQueryPtr query
Definition: SpanQueryFilter.h:28
virtual SpanFilterResultPtr bitSpans(const IndexReaderPtr &reader)
Returns a SpanFilterResult with true for documents which should be permitted in search results,...
virtual DocIdSetPtr getDocIdSet(const IndexReaderPtr &reader)
Creates a DocIdSet enumerating the documents that should be permitted in search results.
Definition: AbstractAllTermDocs.h:12
boost::shared_ptr< SpanQuery > SpanQueryPtr
Definition: LuceneTypes.h:450
boost::shared_ptr< LuceneObject > LuceneObjectPtr
Definition: LuceneTypes.h:539
boost::shared_ptr< DocIdSet > DocIdSetPtr
Definition: LuceneTypes.h:323
boost::shared_ptr< SpanFilterResult > SpanFilterResultPtr
Definition: LuceneTypes.h:445
boost::shared_ptr< IndexReader > IndexReaderPtr
Definition: LuceneTypes.h:157

clucene.sourceforge.net