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 protected org.apache.commons.codec.Encoder
encoder
phonetic encoderprotected boolean
inject
true if encoded tokens should be added as synonymsprotected AttributeSource.State
save
captured state, non-null wheninject=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(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
All Methods Instance Methods Concrete Methods 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
-
-
-
-
Field Detail
-
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 AttributeSource.State save
captured state, non-null wheninject=true
and a token is buffered
-
-
Constructor Detail
-
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 Detail
-
incrementToken
public boolean incrementToken() throws IOException
- Specified by:
incrementToken
in classTokenStream
- Throws:
IOException
-
reset
public void reset() throws IOException
- Overrides:
reset
in classTokenFilter
- Throws:
IOException
-
-