org.apache.lucene.analysis

Class ISOLatin1AccentFilter

java.lang.Object

org.apache.lucene.analysis.TokenStream

org.apache.lucene.analysis.TokenFilter

org.apache.lucene.analysis.ISOLatin1AccentFilter

public class ISOLatin1AccentFilter
extends TokenFilter

A filter that replaces accented characters in the ISO Latin 1 character set (ISO-8859-1) by their unaccented equivalent. The case will not be altered.

For instance, 'à' will be replaced by 'a'.

Constructor Summary

Constructors

Constructor and Description
ISOLatin1AccentFilter(TokenStream input)

Method Summary

Modifier and Type	Method and Description
Token	next(Token result) Returns the next token in the stream, or null at EOS.
void	removeAccents(char[] input, int length) To replace accented characters in a String by unaccented equivalents.

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

close

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

next, reset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ISOLatin1AccentFilter

public ISOLatin1AccentFilter(TokenStream input)

Method Detail

next

public final Token next(Token result)
                 throws java.io.IOException

Description copied from class: TokenStream

Returns the next token in the stream, or null at EOS. When possible, the input Token should be used as the returned Token (this gives fastest tokenization performance), but this is not required and a new Token may be returned. Callers may re-use a single Token instance for successive calls to this method.

This implicitly defines a "contract" between consumers (callers of this method) and producers (implementations of this method that are the source for tokens):

• A consumer must fully consume the previously returned Token before calling this method again.
• A producer must call Token.clear() before setting the fields in it & returning it

Note that a TokenFilter is considered a consumer.

Overrides:

next in class TokenStream

Parameters:

result - a Token that may or may not be used to return

Returns:

next token in the stream or null if end-of-stream was hit

Throws:

java.io.IOException

removeAccents

public final void removeAccents(char[] input,
                                int length)

To replace accented characters in a String by unaccented equivalents.