org.hibernate.search.analyzer.impl

Class ScopedLuceneAnalyzer

java.lang.Object

org.apache.lucene.analysis.Analyzer

org.apache.lucene.analysis.AnalyzerWrapper

org.hibernate.search.analyzer.impl.ScopedLuceneAnalyzer

All Implemented Interfaces:

Closeable, AutoCloseable, 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

Modifier and Type	Class and Description
static class	ScopedLuceneAnalyzer.Builder

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(LuceneAnalyzerReference globalAnalyzerReference)
ScopedLuceneAnalyzer(ScopedLuceneAnalyzer.Builder builder)

Method Summary

Modifier and Type	Method and Description
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.
ScopedLuceneAnalyzer.Builder	startCopy()
String	toString()

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

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

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

close

Constructor Detail

ScopedLuceneAnalyzer

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

ScopedLuceneAnalyzer

public ScopedLuceneAnalyzer(LuceneAnalyzerReference globalAnalyzerReference)

ScopedLuceneAnalyzer

public ScopedLuceneAnalyzer(ScopedLuceneAnalyzer.Builder builder)

Method Detail

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

startCopy

public ScopedLuceneAnalyzer.Builder startCopy()

Specified by:

startCopy in interface ScopedAnalyzer

Returns:

A builder for copying the referenced analyzer, altering some scopes as necessary.

toString

public String toString()

Overrides:

toString in class Object