aitools::invertedindex::RecordReader< Value > Class Template Reference

#include <RecordReader.hpp>

List of all members.

Public Member Functions
	RecordReader ()
virtual	~RecordReader ()
virtual void	close ()=0
virtual bool	next (Record< Value > &record)=0
virtual void	open (const bfs::path &path)=0

---

Detailed Description

template<typename Value>
class aitools::invertedindex::RecordReader< Value >

An abstract class which represents a record reader. A record reader is used by the index as a source of records to be indexed.

Author:

martin.trenkmann@uni-weimar.de

Created on Jun 22, 2008

Id

RecordReader.hpp,v 1.2 2010/05/11 23:41:08 trenkman Exp

Definition at line 25 of file RecordReader.hpp.

---

Constructor & Destructor Documentation

template<typename Value>

aitools::invertedindex::RecordReader< Value >::RecordReader

(

)

[inline]

The default constructor.

Definition at line 32 of file RecordReader.hpp.

template<typename Value>

virtual aitools::invertedindex::RecordReader< Value >::~RecordReader

(

)

[inline, virtual]

The destructor.

Definition at line 37 of file RecordReader.hpp.

---

Member Function Documentation

template<typename Value>

virtual void aitools::invertedindex::RecordReader< Value >::close

(

)

[pure virtual]

Closes the file currently associated with the object.

Implemented in aitools::invertedindex::InvertedFileReader< Value >, and aitools::invertedindex::NGramFileReader.

template<typename Value>

virtual bool aitools::invertedindex::RecordReader< Value >::next

(

Record< Value > &

record

)

[pure virtual]

Extracts the next record by resetting the content of the given record.

Parameters:

record

A record to fill with new content.

Returns:

true if a new record could be extracted successfully, and false otherwise, which signals the end of the stream.

Implemented in aitools::invertedindex::InvertedFileReader< Value >, and aitools::invertedindex::NGramFileReader.

template<typename Value>

virtual void aitools::invertedindex::RecordReader< Value >::open

(

const bfs::path &

path

)

[pure virtual]

Opens a file and initializes the reader to extract records. Invoking this method on an already opened file is illegal.

Parameters:

path

The path of the file to be opened.

Implemented in aitools::invertedindex::InvertedFileReader< Value >, and aitools::invertedindex::NGramFileReader.

---

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

• /home/palakars/workspace-inprogress/code-in-progress/aitools3/aitools3-aq-invertedindex-cpp/src/reader/RecordReader.hpp