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

public class PhoneticFilter
extends TokenFilter

Create tokens for phonetic matches. See: http://jakarta.apache.org/commons/codec/api-release/org/apache/commons/codec/language/package-summary.html

Nested Class Summary

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

AttributeSource.AttributeFactory, AttributeSource.State

Field Summary

protected org.apache.commons.codec.Encoder	encoder
protected boolean	inject
protected AttributeSource.State	save

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

input

Constructor Summary

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

Method Summary

boolean	incrementToken() Consumers (i.e., IndexWriter) use this method to advance the stream to the next token.
void	reset() Reset the filter as well as the input TokenStream.

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

close, end

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

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

Methods inherited from class java.lang.Object

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

Field Detail

inject

protected boolean inject

encoder

protected org.apache.commons.codec.Encoder encoder

save

protected AttributeSource.State save

Constructor Detail

PhoneticFilter

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

Method Detail

incrementToken

public final 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

Reset the filter as well as the input TokenStream.

Overrides:

reset in class TokenFilter

Throws:

IOException