lucene::index::TermVectorsReader Class Reference

#include <TermVector.h>

Inheritance diagram for lucene::index::TermVectorsReader:

List of all members.

Public Member Functions
	TermVectorsReader (lucene::store::Directory *d, const char *segment, FieldInfos *fieldInfos)
	~TermVectorsReader ()
void	close ()
TermVectorsReader *	clone () const
TermFreqVector *	get (const int32_t docNum, const TCHAR *field)
	Retrieve the term vector for the given document and field.
bool	get (int32_t docNum, Array< TermFreqVector * > &result)
	Return all term vectors stored for this document or null if the could not be read in.

---

Detailed Description

Version:

$Id:

---

Constructor & Destructor Documentation

lucene::index::TermVectorsReader::TermVectorsReader	(	lucene::store::Directory *	d,
		const char *	segment,
		FieldInfos *	fieldInfos
	)

lucene::index::TermVectorsReader::~TermVectorsReader

(

)

---

Member Function Documentation

TermVectorsReader* lucene::index::TermVectorsReader::clone

(

)

const

void lucene::index::TermVectorsReader::close

(

)

bool lucene::index::TermVectorsReader::get	(	int32_t	docNum,
		Array< TermFreqVector * > &	result
	)

Return all term vectors stored for this document or null if the could not be read in.

Parameters:

docNum

The document number to retrieve the vector for

Returns:

All term frequency vectors

Exceptions:

IOException

if there is an error reading the term vector files

TermFreqVector* lucene::index::TermVectorsReader::get	(	const int32_t	docNum,
		const TCHAR *	field
	)

Retrieve the term vector for the given document and field.

Parameters:

	docNum	The document number to retrieve the vector for
	field	The field within the document to retrieve

Returns:

The TermFreqVector for the document and field or null if there is no termVector for this field.

Exceptions:

IOException

if there is an error reading the term vector files

---

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

• TermVector.h