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


lucene::analysis::TokenFilter Class Reference

A TokenFilter is a TokenStream whose input is another token stream. More...

#include <AnalysisHeader.h>

Inheritance diagram for lucene::analysis::TokenFilter:
lucene::analysis::TokenStream lucene::debug::LuceneBase lucene::analysis::ISOLatin1AccentFilter lucene::analysis::LengthFilter lucene::analysis::LowerCaseFilter lucene::analysis::standard::StandardFilter lucene::analysis::StopFilter

List of all members.

Public Member Functions

void close ()
 Close the input TokenStream.

Protected Member Functions

 TokenFilter (TokenStream *in, bool deleteTS=false)
 Construct a token stream filtering the given input.
virtual ~TokenFilter ()

Protected Attributes

TokenStreaminput
 The source of tokens for this filter.
bool deleteTokenStream
 If true then input will be deleted in the destructor.

Detailed Description

A TokenFilter is a TokenStream whose input is another token stream.

This is an abstract class.


Constructor & Destructor Documentation

lucene::analysis::TokenFilter::TokenFilter ( TokenStream in,
bool  deleteTS = false 
) [protected]

Construct a token stream filtering the given input.

Parameters:
in The TokenStream to filter from
deleteTS If true, input will be deleted in the destructor
virtual lucene::analysis::TokenFilter::~TokenFilter (  )  [protected, virtual]

Member Function Documentation

void lucene::analysis::TokenFilter::close (  )  [virtual]

Close the input TokenStream.

Implements lucene::analysis::TokenStream.


Member Data Documentation

If true then input will be deleted in the destructor.

The source of tokens for this filter.


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

clucene.sourceforge.net