org.hibernate.search.util.impl

Class ScopedLuceneAnalyzer

java.lang.Object

org.apache.lucene.analysis.Analyzer

org.apache.lucene.analysis.AnalyzerWrapper

org.hibernate.search.util.impl.ScopedLuceneAnalyzer

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable, ScopedAnalyzer

public final class ScopedLuceneAnalyzer
extends org.apache.lucene.analysis.AnalyzerWrapper
implements ScopedAnalyzer

A ScopedLuceneAnalyzer is a wrapper class containing all analyzers for a given class. ScopedLuceneAnalyzer behaves similar to PerFieldAnalyzerWrapper by delegating requests for TokenStreams to the underlying Analyzer depending on the requested field name.

Author:

Emmanuel Bernard, Sanne Grinovero

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.analysis.Analyzer

org.apache.lucene.analysis.Analyzer.ReuseStrategy, org.apache.lucene.analysis.Analyzer.TokenStreamComponents

Field Summary

Fields inherited from class org.apache.lucene.analysis.Analyzer

GLOBAL_REUSE_STRATEGY, PER_FIELD_REUSE_STRATEGY

Constructor Summary

Constructors

Constructor and Description
ScopedLuceneAnalyzer(org.apache.lucene.analysis.Analyzer globalAnalyzer)
ScopedLuceneAnalyzer(AnalyzerReference globalAnalyzerReference)

Method Summary

Modifier and Type	Method and Description
void	addScopedAnalyzer(String scope, org.apache.lucene.analysis.Analyzer scopedAnalyzer)
void	addScopedAnalyzerReference(String scope, AnalyzerReference analyzerReference)
void	addScopedPassThroughAnalyzerReference(String scope)
ScopedLuceneAnalyzer	clone()
protected org.apache.lucene.analysis.Analyzer	getWrappedAnalyzer(String fieldName)
boolean	isCompositeOfSameInstances(ScopedLuceneAnalyzer other) Compares the references of the global analyzer backing this ScopedAnalyzer and each scoped analyzer.
void	setGlobalAnalyzerReference(AnalyzerReference globalAnalyzerReference)

Methods inherited from class org.apache.lucene.analysis.AnalyzerWrapper

createComponents, getOffsetGap, getPositionIncrementGap, initReader, wrapComponents, wrapReader

Methods inherited from class org.apache.lucene.analysis.Analyzer

close, getReuseStrategy, getVersion, setVersion, tokenStream, tokenStream

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.search.analyzer.impl.ScopedAnalyzer

close

Constructor Detail

ScopedLuceneAnalyzer

public ScopedLuceneAnalyzer(org.apache.lucene.analysis.Analyzer globalAnalyzer)

ScopedLuceneAnalyzer

public ScopedLuceneAnalyzer(AnalyzerReference globalAnalyzerReference)

Method Detail

setGlobalAnalyzerReference

public void setGlobalAnalyzerReference(AnalyzerReference globalAnalyzerReference)

Specified by:

setGlobalAnalyzerReference in interface ScopedAnalyzer

addScopedAnalyzer

public void addScopedAnalyzer(String scope,
                              org.apache.lucene.analysis.Analyzer scopedAnalyzer)

addScopedAnalyzerReference

public void addScopedAnalyzerReference(String scope,
                                       AnalyzerReference analyzerReference)

Specified by:

addScopedAnalyzerReference in interface ScopedAnalyzer

addScopedPassThroughAnalyzerReference

public void addScopedPassThroughAnalyzerReference(String scope)

Specified by:

addScopedPassThroughAnalyzerReference in interface ScopedAnalyzer

isCompositeOfSameInstances

public boolean isCompositeOfSameInstances(ScopedLuceneAnalyzer other)

Compares the references of the global analyzer backing this ScopedAnalyzer and each scoped analyzer.

Parameters:

other - ScopedAnalyzer to compare to

Returns:

true if and only if the same instance of global analyzer is being used and all scoped analyzers also match, by reference.

getWrappedAnalyzer

protected org.apache.lucene.analysis.Analyzer getWrappedAnalyzer(String fieldName)

Specified by:

getWrappedAnalyzer in class org.apache.lucene.analysis.AnalyzerWrapper

clone

public ScopedLuceneAnalyzer clone()

Specified by:

clone in interface ScopedAnalyzer

Overrides:

clone in class Object