Package org.apache.lucene.analysis.phonetic

Class PhoneticFilter

java.lang.Object

org.apache.lucene.util.AttributeSource

org.apache.lucene.analysis.TokenStream

org.apache.lucene.analysis.TokenFilter

org.apache.lucene.analysis.phonetic.PhoneticFilter

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.lucene.util.Unwrappable<org.apache.lucene.analysis.TokenStream>

public final class PhoneticFilter
extends org.apache.lucene.analysis.TokenFilter

Create tokens for phonetic matches.

See Also:

• Apache Commons Codec

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource

org.apache.lucene.util.AttributeSource.State

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.commons.codec.Encoder	encoder	phonetic encoder
protected boolean	inject	true if encoded tokens should be added as synonyms
protected org.apache.lucene.util.AttributeSource.State	save	captured state, non-null when inject=true and a token is buffered

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

input

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

DEFAULT_TOKEN_ATTRIBUTE_FACTORY

Constructor Summary

Constructors

Constructor	Description
PhoneticFilter(org.apache.lucene.analysis.TokenStream in, org.apache.commons.codec.Encoder encoder, boolean inject)	Creates a PhoneticFilter with the specified encoder, and either adding encoded forms as synonyms (inject=true) or replacing them.

Method Summary

Modifier and Type	Method	Description
boolean	incrementToken()
void	reset()

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

close, end, unwrap

Methods inherited from class org.apache.lucene.util.AttributeSource

addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, endAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, removeAllAttributes, restoreState, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

inject

protected boolean inject

true if encoded tokens should be added as synonyms

encoder

protected org.apache.commons.codec.Encoder encoder

phonetic encoder

save

protected org.apache.lucene.util.AttributeSource.State save

captured state, non-null when inject=true and a token is buffered

Constructor Details

PhoneticFilter

public PhoneticFilter(org.apache.lucene.analysis.TokenStream in,
 org.apache.commons.codec.Encoder encoder,
 boolean inject)

Creates a PhoneticFilter with the specified encoder, and either adding encoded forms as synonyms (inject=true) or replacing them.

Method Details

incrementToken

public boolean incrementToken()
                       throws IOException

Specified by:

incrementToken in class org.apache.lucene.analysis.TokenStream

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class org.apache.lucene.analysis.TokenFilter

Throws:

IOException