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


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Attributes
Lucene::SpanFilterResult Class Reference

The results of a SpanQueryFilter. Wraps the BitSet and the position information from the SpanQuery. More...

#include <SpanFilterResult.h>

+ Inheritance diagram for Lucene::SpanFilterResult:

Public Member Functions

 SpanFilterResult (const DocIdSetPtr &docIdSet, Collection< PositionInfoPtr > positions)
 
virtual ~SpanFilterResult ()
 
virtual String getClassName ()
 
boost::shared_ptr< SpanFilterResultshared_from_this ()
 
Collection< PositionInfoPtrgetPositions ()
 The first entry in the array corresponds to the first "on" bit. Entries are increasing by document order.
 
DocIdSetPtr getDocIdSet ()
 Returns the docIdSet.
 
- Public Member Functions inherited from Lucene::LuceneObject
virtual ~LuceneObject ()
 
virtual void initialize ()
 Called directly after instantiation to create objects that depend on this object being fully constructed.
 
virtual LuceneObjectPtr clone (const LuceneObjectPtr &other=LuceneObjectPtr())
 Return clone of this object.
 
virtual int32_t hashCode ()
 Return hash code for this object.
 
virtual bool equals (const LuceneObjectPtr &other)
 Return whether two objects are equal.
 
virtual int32_t compareTo (const LuceneObjectPtr &other)
 Compare two objects.
 
virtual String toString ()
 Returns a string representation of the object.
 
- Public Member Functions inherited from Lucene::LuceneSync
virtual ~LuceneSync ()
 
virtual SynchronizePtr getSync ()
 Return this object synchronize lock.
 
virtual LuceneSignalPtr getSignal ()
 Return this object signal.
 
virtual void lock (int32_t timeout=0)
 Lock this object using an optional timeout.
 
virtual void unlock ()
 Unlock this object.
 
virtual bool holdsLock ()
 Returns true if this object is currently locked by current thread.
 
virtual void wait (int32_t timeout=0)
 Wait for signal using an optional timeout.
 
virtual void notifyAll ()
 Notify all threads waiting for signal.
 

Static Public Member Functions

static String _getClassName ()
 

Protected Attributes

DocIdSetPtr docIdSet
 
Collection< PositionInfoPtrpositions
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Additional Inherited Members

- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 

Detailed Description

The results of a SpanQueryFilter. Wraps the BitSet and the position information from the SpanQuery.

Constructor & Destructor Documentation

◆ SpanFilterResult()

Lucene::SpanFilterResult::SpanFilterResult ( const DocIdSetPtr docIdSet,
Collection< PositionInfoPtr positions 
)
Parameters
docIdSetThe DocIdSet for the Filter
positionsA List of PositionInfo objects

◆ ~SpanFilterResult()

virtual Lucene::SpanFilterResult::~SpanFilterResult ( )
virtual

Member Function Documentation

◆ _getClassName()

static String Lucene::SpanFilterResult::_getClassName ( )
inlinestatic

◆ getClassName()

virtual String Lucene::SpanFilterResult::getClassName ( )
inlinevirtual

◆ getDocIdSet()

DocIdSetPtr Lucene::SpanFilterResult::getDocIdSet ( )

Returns the docIdSet.

◆ getPositions()

Collection< PositionInfoPtr > Lucene::SpanFilterResult::getPositions ( )

The first entry in the array corresponds to the first "on" bit. Entries are increasing by document order.

Returns
A List of PositionInfo objects

◆ shared_from_this()

boost::shared_ptr< SpanFilterResult > Lucene::SpanFilterResult::shared_from_this ( )
inline

Field Documentation

◆ docIdSet

DocIdSetPtr Lucene::SpanFilterResult::docIdSet
protected

◆ positions

Collection<PositionInfoPtr> Lucene::SpanFilterResult::positions
protected

The documentation for this class was generated from the following file:

clucene.sourceforge.net