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


 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Static Public Member Functions | Protected Attributes
Lucene::FieldSortedTermVectorMapper Class Reference

For each Field, store a sorted collection of TermVectorEntrys This is not thread-safe. More...

#include <FieldSortedTermVectorMapper.h>

+ Inheritance diagram for Lucene::FieldSortedTermVectorMapper:

Public Member Functions

 FieldSortedTermVectorMapper (TermVectorEntryComparator comparator)
 FieldSortedTermVectorMapper (bool ignoringPositions, bool ignoringOffsets, TermVectorEntryComparator comparator)
virtual ~FieldSortedTermVectorMapper ()
virtual String getClassName ()
boost::shared_ptr
< FieldSortedTermVectorMapper
shared_from_this ()
virtual void map (const String &term, int32_t frequency, Collection< TermVectorOffsetInfoPtr > offsets, Collection< int32_t > positions)
 Map the Term Vector information into your own structure.
virtual void setExpectations (const String &field, int32_t numTerms, bool storeOffsets, bool storePositions)
 Tell the mapper what to expect in regards to field, number of terms, offset and position storage.
MapStringCollectionTermVectorEntry getFieldToTerms ()
 Get the mapping between fields and terms, sorted by the comparator.
TermVectorEntryComparator getComparator ()
- Public Member Functions inherited from Lucene::TermVectorMapper
 TermVectorMapper (bool ignoringPositions=false, bool ignoringOffsets=false)
virtual ~TermVectorMapper ()
virtual bool isIgnoringPositions ()
 Indicate to Lucene that even if there are positions stored, this mapper is not interested in them and they can be skipped over. Derived classes should set this to true if they want to ignore positions. The default is false, meaning positions will be loaded if they are stored.
virtual bool isIgnoringOffsets ()
virtual void setDocumentNumber (int32_t documentNumber)
 Passes down the index of the document whose term vector is currently being mapped, once for each top level call to a term vector reader.
- 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

MapStringCollectionTermVectorEntry fieldToTerms
Collection< TermVectorEntryPtrcurrentSet
String currentField
TermVectorEntryComparator comparator
- Protected Attributes inherited from Lucene::TermVectorMapper
bool ignoringPositions
bool ignoringOffsets

Additional Inherited Members

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

Detailed Description

For each Field, store a sorted collection of TermVectorEntrys This is not thread-safe.

Constructor & Destructor Documentation

Lucene::FieldSortedTermVectorMapper::FieldSortedTermVectorMapper ( TermVectorEntryComparator  comparator)
Parameters
comparatorA Comparator for sorting TermVectorEntrys
Lucene::FieldSortedTermVectorMapper::FieldSortedTermVectorMapper ( bool  ignoringPositions,
bool  ignoringOffsets,
TermVectorEntryComparator  comparator 
)
virtual Lucene::FieldSortedTermVectorMapper::~FieldSortedTermVectorMapper ( )
virtual

Member Function Documentation

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

Reimplemented from Lucene::TermVectorMapper.

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

Reimplemented from Lucene::TermVectorMapper.

TermVectorEntryComparator Lucene::FieldSortedTermVectorMapper::getComparator ( )
MapStringCollectionTermVectorEntry Lucene::FieldSortedTermVectorMapper::getFieldToTerms ( )

Get the mapping between fields and terms, sorted by the comparator.

Returns
A map between field names and java.util.SortedSets per field. SortedSet entries are TermVectorEntry
virtual void Lucene::FieldSortedTermVectorMapper::map ( const String &  term,
int32_t  frequency,
Collection< TermVectorOffsetInfoPtr offsets,
Collection< int32_t >  positions 
)
virtual

Map the Term Vector information into your own structure.

Implements Lucene::TermVectorMapper.

virtual void Lucene::FieldSortedTermVectorMapper::setExpectations ( const String &  field,
int32_t  numTerms,
bool  storeOffsets,
bool  storePositions 
)
virtual

Tell the mapper what to expect in regards to field, number of terms, offset and position storage.

Implements Lucene::TermVectorMapper.

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

Reimplemented from Lucene::TermVectorMapper.

Field Documentation

TermVectorEntryComparator Lucene::FieldSortedTermVectorMapper::comparator
protected
String Lucene::FieldSortedTermVectorMapper::currentField
protected
Collection<TermVectorEntryPtr> Lucene::FieldSortedTermVectorMapper::currentSet
protected
MapStringCollectionTermVectorEntry Lucene::FieldSortedTermVectorMapper::fieldToTerms
protected

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

clucene.sourceforge.net