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


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Data Fields
Lucene::TermInfo Class Reference

A TermInfo is the record of information stored for a term. More...

#include <TermInfo.h>

+ Inheritance diagram for Lucene::TermInfo:

Public Member Functions

 TermInfo (const TermInfoPtr &ti)
 
 TermInfo (int32_t df=0, int64_t fp=0, int64_t pp=0)
 
virtual ~TermInfo ()
 
virtual String getClassName ()
 
boost::shared_ptr< TermInfoshared_from_this ()
 
void set (int32_t docFreq, int64_t freqPointer, int64_t proxPointer, int32_t skipOffset)
 
void set (const TermInfoPtr &ti)
 
- 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 ()
 

Data Fields

int32_t docFreq
 The number of documents which contain the term.
 
int64_t freqPointer
 
int64_t proxPointer
 
int32_t skipOffset
 

Additional Inherited Members

- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Detailed Description

A TermInfo is the record of information stored for a term.

Constructor & Destructor Documentation

◆ TermInfo() [1/2]

Lucene::TermInfo::TermInfo ( const TermInfoPtr ti)

◆ TermInfo() [2/2]

Lucene::TermInfo::TermInfo ( int32_t  df = 0,
int64_t  fp = 0,
int64_t  pp = 0 
)

◆ ~TermInfo()

virtual Lucene::TermInfo::~TermInfo ( )
virtual

Member Function Documentation

◆ _getClassName()

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

◆ getClassName()

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

◆ set() [1/2]

void Lucene::TermInfo::set ( const TermInfoPtr ti)

◆ set() [2/2]

void Lucene::TermInfo::set ( int32_t  docFreq,
int64_t  freqPointer,
int64_t  proxPointer,
int32_t  skipOffset 
)

◆ shared_from_this()

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

Field Documentation

◆ docFreq

int32_t Lucene::TermInfo::docFreq

The number of documents which contain the term.

◆ freqPointer

int64_t Lucene::TermInfo::freqPointer

◆ proxPointer

int64_t Lucene::TermInfo::proxPointer

◆ skipOffset

int32_t Lucene::TermInfo::skipOffset

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

clucene.sourceforge.net