Module org.apache.lucene.analysis.phonetic

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, Unwrappable<TokenStream>

public final class PhoneticFilter
extends 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

AttributeSource.State

Field Summary

Fields

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

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(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()	Consumers (i.e., IndexWriter) use this method to advance the stream to the next token.
void	reset()	This method is called by a consumer before it begins consumption using TokenStream.incrementToken().

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

private final boolean inject

true if encoded tokens should be added as synonyms

encoder

private final org.apache.commons.codec.Encoder encoder

phonetic encoder

save

private AttributeSource.State save

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

termAtt

private final CharTermAttribute termAtt

posAtt

private final PositionIncrementAttribute posAtt

Constructor Details

PhoneticFilter

public PhoneticFilter(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

Description copied from class: TokenStream

Consumers (i.e., IndexWriter) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriate AttributeImpls with the attributes of the next token.

The producer must make no assumptions about the attributes after the method has been returned: the caller may arbitrarily change it. If the producer needs to preserve the state for subsequent calls, it can use AttributeSource.captureState() to create a copy of the current attribute state.

This method is called for every token of a document, so an efficient implementation is crucial for good performance. To avoid calls to AttributeSource.addAttribute(Class) and AttributeSource.getAttribute(Class), references to all AttributeImpls that this stream uses should be retrieved during instantiation.

To ensure that filters and consumers know which attributes are available, the attributes must be added during instantiation. Filters and consumers are not required to check for availability of attributes in TokenStream.incrementToken().

Specified by:

incrementToken in class TokenStream

Returns:

false for end of stream; true otherwise

Throws:

IOException

reset

public void reset()
           throws IOException

Description copied from class: TokenFilter

This method is called by a consumer before it begins consumption using TokenStream.incrementToken().

Resets this stream to a clean state. Stateful implementations must implement this method so that they can be reused, just as if they had been created fresh.

If you override this method, always call super.reset(), otherwise some internal state will not be correctly reset (e.g., Tokenizer will throw IllegalStateException on further usage).

NOTE: The default implementation chains the call to the input TokenStream, so be sure to call super.reset() when overriding this method.

Overrides:

reset in class TokenFilter

Throws:

IOException