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::TermVectorsWriter Class Reference

#include <TermVectorsWriter.h>

+ Inheritance diagram for Lucene::TermVectorsWriter:

Public Member Functions

 TermVectorsWriter (DirectoryPtr directory, const String &segment, FieldInfosPtr fieldInfos)
 
virtual ~TermVectorsWriter ()
 
virtual String getClassName ()
 
boost::shared_ptr
< TermVectorsWriter
shared_from_this ()
 
void addAllDocVectors (Collection< TermFreqVectorPtr > vectors)
 Add a complete document specified by all its term vectors. If document has no term vectors, add value for tvx. More...
 
void addRawDocuments (TermVectorsReaderPtr reader, Collection< int32_t > tvdLengths, Collection< int32_t > tvfLengths, int32_t numDocs)
 Do a bulk copy of numDocs documents from reader to our streams. This is used to expedite merging, if the field numbers are congruent. More...
 
void close ()
 Close all streams. More...
 
- 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. More...
 
virtual LuceneObjectPtr clone (LuceneObjectPtr other=LuceneObjectPtr())
 Return clone of this object. More...
 
virtual int32_t hashCode ()
 Return hash code for this object. More...
 
virtual bool equals (LuceneObjectPtr other)
 Return whether two objects are equal. More...
 
virtual int32_t compareTo (LuceneObjectPtr other)
 Compare two objects. More...
 
virtual String toString ()
 Returns a string representation of the object. More...
 
- Public Member Functions inherited from Lucene::LuceneSync
virtual ~LuceneSync ()
 
virtual SynchronizePtr getSync ()
 Return this object synchronize lock. More...
 
virtual LuceneSignalPtr getSignal ()
 Return this object signal. More...
 
virtual void lock (int32_t timeout=0)
 Lock this object using an optional timeout. More...
 
virtual void unlock ()
 Unlock this object. More...
 
virtual bool holdsLock ()
 Returns true if this object is currently locked by current thread. More...
 
virtual void wait (int32_t timeout=0)
 Wait for signal using an optional timeout. More...
 
virtual void notifyAll ()
 Notify all threads waiting for signal. More...
 

Static Public Member Functions

static String _getClassName ()
 

Protected Attributes

IndexOutputPtr tvx
 
IndexOutputPtr tvd
 
IndexOutputPtr tvf
 
FieldInfosPtr fieldInfos
 
Collection< UTF8ResultPtrutf8Results
 

Additional Inherited Members

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

Constructor & Destructor Documentation

Lucene::TermVectorsWriter::TermVectorsWriter ( DirectoryPtr  directory,
const String &  segment,
FieldInfosPtr  fieldInfos 
)
virtual Lucene::TermVectorsWriter::~TermVectorsWriter ( )
virtual

Member Function Documentation

static String Lucene::TermVectorsWriter::_getClassName ( )
inlinestatic
void Lucene::TermVectorsWriter::addAllDocVectors ( Collection< TermFreqVectorPtr vectors)

Add a complete document specified by all its term vectors. If document has no term vectors, add value for tvx.

void Lucene::TermVectorsWriter::addRawDocuments ( TermVectorsReaderPtr  reader,
Collection< int32_t >  tvdLengths,
Collection< int32_t >  tvfLengths,
int32_t  numDocs 
)

Do a bulk copy of numDocs documents from reader to our streams. This is used to expedite merging, if the field numbers are congruent.

void Lucene::TermVectorsWriter::close ( )

Close all streams.

virtual String Lucene::TermVectorsWriter::getClassName ( )
inlinevirtual
boost::shared_ptr< TermVectorsWriter > Lucene::TermVectorsWriter::shared_from_this ( )
inline

Field Documentation

FieldInfosPtr Lucene::TermVectorsWriter::fieldInfos
protected
IndexOutputPtr Lucene::TermVectorsWriter::tvd
protected
IndexOutputPtr Lucene::TermVectorsWriter::tvf
protected
IndexOutputPtr Lucene::TermVectorsWriter::tvx
protected
Collection<UTF8ResultPtr> Lucene::TermVectorsWriter::utf8Results
protected

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

clucene.sourceforge.net