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


Public Member Functions | Static Public Member Functions | Protected Attributes
Lucene::PerFieldAnalyzerWrapper Class Reference

This analyzer is used to facilitate scenarios where different fields require different analysis techniques. Use addAnalyzer to add a non-default analyzer on a field name basis. More...

#include <PerFieldAnalyzerWrapper.h>

+ Inheritance diagram for Lucene::PerFieldAnalyzerWrapper:

Public Member Functions

 PerFieldAnalyzerWrapper (const AnalyzerPtr &defaultAnalyzer)
 Constructs with default analyzer. More...
 
 PerFieldAnalyzerWrapper (const AnalyzerPtr &defaultAnalyzer, MapStringAnalyzer fieldAnalyzers)
 Constructs with default analyzer and a map of analyzers to use for specific fields. More...
 
virtual ~PerFieldAnalyzerWrapper ()
 
virtual String getClassName ()
 
boost::shared_ptr< PerFieldAnalyzerWrappershared_from_this ()
 
void addAnalyzer (const String &fieldName, const AnalyzerPtr &analyzer)
 Defines an analyzer to use for the specified field. More...
 
virtual TokenStreamPtr tokenStream (const String &fieldName, const ReaderPtr &reader)
 Creates a TokenStream which tokenizes all the text in the provided Reader. Must be able to handle null field name for backward compatibility. More...
 
virtual TokenStreamPtr reusableTokenStream (const String &fieldName, const ReaderPtr &reader)
 Creates a TokenStream that is allowed to be re-used from the previous time that the same thread called this method. Callers that do not need to use more than one TokenStream at the same time from this analyzer should use this method for better performance. More...
 
virtual int32_t getPositionIncrementGap (const String &fieldName)
 Return the positionIncrementGap from the analyzer assigned to fieldName. More...
 
virtual int32_t getOffsetGap (const FieldablePtr &field)
 Return the offsetGap from the analyzer assigned to field. More...
 
virtual String toString ()
 Returns a string representation of the object. More...
 
- Public Member Functions inherited from Lucene::Analyzer
virtual ~Analyzer ()
 
virtual String getClassName ()
 
boost::shared_ptr< Analyzershared_from_this ()
 
virtual TokenStreamPtr tokenStream (const String &fieldName, const ReaderPtr &reader)=0
 Creates a TokenStream which tokenizes all the text in the provided Reader. Must be able to handle null field name for backward compatibility. More...
 
virtual TokenStreamPtr reusableTokenStream (const String &fieldName, const ReaderPtr &reader)
 Creates a TokenStream that is allowed to be re-used from the previous time that the same thread called this method. Callers that do not need to use more than one TokenStream at the same time from this analyzer should use this method for better performance. More...
 
virtual int32_t getPositionIncrementGap (const String &fieldName)
 Invoked before indexing a Fieldable instance if terms have already been added to that field. This allows custom analyzers to place an automatic position increment gap between Fieldable instances using the same field name. The default value position increment gap is 0. With a 0 position increment gap and the typical default token position increment of 1, all terms in a field, including across Fieldable instances, are in successive positions, allowing exact PhraseQuery matches, for instance, across Fieldable instance boundaries. More...
 
virtual int32_t getOffsetGap (const FieldablePtr &field)
 Just like getPositionIncrementGap, except for Token offsets instead. By default this returns 1 for tokenized fields and, as if the fields were joined with an extra space character, and 0 for un-tokenized fields. This method is only called if the field produced at least one token for indexing. More...
 
virtual void close ()
 Frees persistent resources used by this Analyzer. 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 (const LuceneObjectPtr &other=LuceneObjectPtr())
 Return clone of this object. More...
 
virtual int32_t hashCode ()
 Return hash code for this object. More...
 
virtual bool equals (const LuceneObjectPtr &other)
 Return whether two objects are equal. More...
 
virtual int32_t compareTo (const 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 ()
 
- Static Public Member Functions inherited from Lucene::Analyzer
static String _getClassName ()
 

Protected Attributes

AnalyzerPtr defaultAnalyzer
 
MapStringAnalyzer analyzerMap
 
- Protected Attributes inherited from Lucene::Analyzer
CloseableThreadLocal< LuceneObjecttokenStreams
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Additional Inherited Members

- Protected Member Functions inherited from Lucene::Analyzer
virtual LuceneObjectPtr getPreviousTokenStream ()
 Used by Analyzers that implement reusableTokenStream to retrieve previously saved TokenStreams for re-use by the same thread. More...
 
virtual void setPreviousTokenStream (const LuceneObjectPtr &stream)
 Used by Analyzers that implement reusableTokenStream to save a TokenStream for later re-use by the same thread. More...
 
- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 

Detailed Description

This analyzer is used to facilitate scenarios where different fields require different analysis techniques. Use addAnalyzer to add a non-default analyzer on a field name basis.

Example usage:

PerFieldAnalyzerWrapperPtr aWrapper = newLucene<PerFieldAnalyzerWrapper>(newLucene<StandardAnalyzer>());
aWrapper->addAnalyzer(L"firstname", newLucene<KeywordAnalyzer>());
aWrapper->addAnalyzer(L"lastname", newLucene<KeywordAnalyzer>());

In this example, StandardAnalyzer will be used for all fields except "firstname" and "lastname", for which KeywordAnalyzer will be used.

A PerFieldAnalyzerWrapper can be used like any other analyzer, for both indexing and query parsing.

Constructor & Destructor Documentation

◆ PerFieldAnalyzerWrapper() [1/2]

Lucene::PerFieldAnalyzerWrapper::PerFieldAnalyzerWrapper ( const AnalyzerPtr defaultAnalyzer)

Constructs with default analyzer.

Parameters
defaultAnalyzerAny fields not specifically defined to use a different analyzer will use the one provided here.

◆ PerFieldAnalyzerWrapper() [2/2]

Lucene::PerFieldAnalyzerWrapper::PerFieldAnalyzerWrapper ( const AnalyzerPtr defaultAnalyzer,
MapStringAnalyzer  fieldAnalyzers 
)

Constructs with default analyzer and a map of analyzers to use for specific fields.

Parameters
defaultAnalyzerAny fields not specifically defined to use a different analyzer will use the one provided here.
fieldAnalyzersa Map (String field name to the Analyzer) to be used for those fields

◆ ~PerFieldAnalyzerWrapper()

virtual Lucene::PerFieldAnalyzerWrapper::~PerFieldAnalyzerWrapper ( )
virtual

Member Function Documentation

◆ _getClassName()

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

◆ addAnalyzer()

void Lucene::PerFieldAnalyzerWrapper::addAnalyzer ( const String &  fieldName,
const AnalyzerPtr analyzer 
)

Defines an analyzer to use for the specified field.

Parameters
fieldNamefield name requiring a non-default analyzer
analyzernon-default analyzer to use for field

◆ getClassName()

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

Reimplemented from Lucene::Analyzer.

◆ getOffsetGap()

virtual int32_t Lucene::PerFieldAnalyzerWrapper::getOffsetGap ( const FieldablePtr field)
virtual

Return the offsetGap from the analyzer assigned to field.

Reimplemented from Lucene::Analyzer.

◆ getPositionIncrementGap()

virtual int32_t Lucene::PerFieldAnalyzerWrapper::getPositionIncrementGap ( const String &  fieldName)
virtual

Return the positionIncrementGap from the analyzer assigned to fieldName.

Reimplemented from Lucene::Analyzer.

◆ reusableTokenStream()

virtual TokenStreamPtr Lucene::PerFieldAnalyzerWrapper::reusableTokenStream ( const String &  fieldName,
const ReaderPtr reader 
)
virtual

Creates a TokenStream that is allowed to be re-used from the previous time that the same thread called this method. Callers that do not need to use more than one TokenStream at the same time from this analyzer should use this method for better performance.

Reimplemented from Lucene::Analyzer.

◆ shared_from_this()

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

◆ tokenStream()

virtual TokenStreamPtr Lucene::PerFieldAnalyzerWrapper::tokenStream ( const String &  fieldName,
const ReaderPtr reader 
)
virtual

Creates a TokenStream which tokenizes all the text in the provided Reader. Must be able to handle null field name for backward compatibility.

Implements Lucene::Analyzer.

◆ toString()

virtual String Lucene::PerFieldAnalyzerWrapper::toString ( )
virtual

Returns a string representation of the object.

Reimplemented from Lucene::LuceneObject.

Field Documentation

◆ analyzerMap

MapStringAnalyzer Lucene::PerFieldAnalyzerWrapper::analyzerMap
protected

◆ defaultAnalyzer

AnalyzerPtr Lucene::PerFieldAnalyzerWrapper::defaultAnalyzer
protected

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

clucene.sourceforge.net