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


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

Convenience class for holding TermVector information. More...

#include <TermVectorEntry.h>

+ Inheritance diagram for Lucene::TermVectorEntry:

Public Member Functions

 TermVectorEntry (const String &field=EmptyString, const String &term=EmptyString, int32_t frequency=0, Collection< TermVectorOffsetInfoPtr > offsets=Collection< TermVectorOffsetInfoPtr >(), Collection< int32_t > positions=Collection< int32_t >())
 
virtual ~TermVectorEntry ()
 
virtual String getClassName ()
 
boost::shared_ptr< TermVectorEntryshared_from_this ()
 
String getField ()
 
int32_t getFrequency ()
 
Collection< TermVectorOffsetInfoPtrgetOffsets ()
 
Collection< int32_t > getPositions ()
 
String getTerm ()
 
void setFrequency (int32_t frequency)
 
void setOffsets (Collection< TermVectorOffsetInfoPtr > offsets)
 
void setPositions (Collection< int32_t > positions)
 
virtual bool equals (const LuceneObjectPtr &other)
 Return whether two objects are equal.
 
virtual int32_t hashCode ()
 Return hash code for this object.
 
virtual String toString ()
 Returns a string representation of the object.
 
- 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 compareTo (const LuceneObjectPtr &other)
 Compare two objects.
 
- 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

String field
 
String term
 
int32_t frequency
 
Collection< TermVectorOffsetInfoPtroffsets
 
Collection< int32_t > positions
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Additional Inherited Members

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

Detailed Description

Convenience class for holding TermVector information.

Constructor & Destructor Documentation

◆ TermVectorEntry()

Lucene::TermVectorEntry::TermVectorEntry ( const String &  field = EmptyString,
const String &  term = EmptyString,
int32_t  frequency = 0,
Collection< TermVectorOffsetInfoPtr offsets = CollectionTermVectorOffsetInfoPtr >(),
Collection< int32_t >  positions = Collection< int32_t >() 
)

◆ ~TermVectorEntry()

virtual Lucene::TermVectorEntry::~TermVectorEntry ( )
virtual

Member Function Documentation

◆ _getClassName()

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

◆ equals()

virtual bool Lucene::TermVectorEntry::equals ( const LuceneObjectPtr other)
virtual

Return whether two objects are equal.

Reimplemented from Lucene::LuceneObject.

◆ getClassName()

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

◆ getField()

String Lucene::TermVectorEntry::getField ( )

◆ getFrequency()

int32_t Lucene::TermVectorEntry::getFrequency ( )

◆ getOffsets()

Collection< TermVectorOffsetInfoPtr > Lucene::TermVectorEntry::getOffsets ( )

◆ getPositions()

Collection< int32_t > Lucene::TermVectorEntry::getPositions ( )

◆ getTerm()

String Lucene::TermVectorEntry::getTerm ( )

◆ hashCode()

virtual int32_t Lucene::TermVectorEntry::hashCode ( )
virtual

Return hash code for this object.

Reimplemented from Lucene::LuceneObject.

◆ setFrequency()

void Lucene::TermVectorEntry::setFrequency ( int32_t  frequency)

◆ setOffsets()

void Lucene::TermVectorEntry::setOffsets ( Collection< TermVectorOffsetInfoPtr offsets)

◆ setPositions()

void Lucene::TermVectorEntry::setPositions ( Collection< int32_t >  positions)

◆ shared_from_this()

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

◆ toString()

virtual String Lucene::TermVectorEntry::toString ( )
virtual

Returns a string representation of the object.

Reimplemented from Lucene::LuceneObject.

Field Documentation

◆ field

String Lucene::TermVectorEntry::field
protected

◆ frequency

int32_t Lucene::TermVectorEntry::frequency
protected

◆ offsets

Collection<TermVectorOffsetInfoPtr> Lucene::TermVectorEntry::offsets
protected

◆ positions

Collection<int32_t> Lucene::TermVectorEntry::positions
protected

◆ term

String Lucene::TermVectorEntry::term
protected

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

clucene.sourceforge.net