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


TermSpans.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 TERMSPANS_H
8 #define TERMSPANS_H
9 
10 #include "Spans.h"
11 
12 namespace Lucene {
13 
15 class LPPAPI TermSpans : public Spans {
16 public:
17  TermSpans(const TermPositionsPtr& positions, const TermPtr& term);
18  virtual ~TermSpans();
19 
21 
22 protected:
25  int32_t _doc;
26  int32_t freq;
27  int32_t count;
28  int32_t position;
29 
30 public:
31  virtual bool next();
32  virtual bool skipTo(int32_t target);
33  virtual int32_t doc();
34  virtual int32_t start();
35  virtual int32_t end();
37  virtual bool isPayloadAvailable();
38  virtual String toString();
39 
41 };
42 
43 }
44 
45 #endif
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
An enumeration of span matches. Used to implement span searching. Each span represents a range of ter...
Definition: Spans.h:17
Public for extension only.
Definition: TermSpans.h:15
TermPtr term
Definition: TermSpans.h:24
virtual int32_t end()
Returns the end position of the current match. Initially invalid.
int32_t position
Definition: TermSpans.h:28
TermPositionsPtr positions
Definition: TermSpans.h:20
int32_t _doc
Definition: TermSpans.h:25
int32_t freq
Definition: TermSpans.h:26
virtual bool skipTo(int32_t target)
Skips to the first match beyond the current, whose document number is greater than or equal to target...
virtual ~TermSpans()
virtual int32_t doc()
Returns the document number of the current match. Initially invalid.
TermSpans(const TermPositionsPtr &positions, const TermPtr &term)
virtual int32_t start()
Returns the start position of the current match. Initially invalid.
virtual bool next()
Move to the next match, returning true if any such exists.
virtual String toString()
Returns a string representation of the object.
virtual Collection< ByteArray > getPayload()
Returns the payload data for the current span. This is invalid until next() is called for the first t...
TermPositionsPtr getPositions()
int32_t count
Definition: TermSpans.h:27
virtual bool isPayloadAvailable()
Checks if a payload can be loaded at this position.
Definition: AbstractAllTermDocs.h:12
boost::shared_ptr< TermPositions > TermPositionsPtr
Definition: LuceneTypes.h:243
boost::shared_ptr< Term > TermPtr
Definition: LuceneTypes.h:233

clucene.sourceforge.net