public final class ASCIIFoldingFilter extends TokenFilter
ISOLatin1AccentFilter
which strips
accents from Latin1 characters. For example, 'à' will be replaced by
'a'.AttributeSource.AttributeFactory, AttributeSource.State
input
Constructor and Description |
---|
ASCIIFoldingFilter(TokenStream input) |
Modifier and Type | Method and Description |
---|---|
void |
foldToASCII(char[] input,
int length)
Converts characters above ASCII to their ASCII equivalents.
|
static int |
foldToASCII(char[] input,
int inputPos,
char[] output,
int outputPos,
int length)
Converts characters above ASCII to their ASCII equivalents.
|
boolean |
incrementToken()
Consumers (i.e.,
IndexWriter ) use this method to advance the stream to
the next token. |
close, end, reset
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString
public ASCIIFoldingFilter(TokenStream input)
public boolean incrementToken() throws IOException
TokenStream
IndexWriter
) use this method to advance the stream to
the next token. Implementing classes must implement this method and update
the appropriate AttributeImpl
s 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 AttributeImpl
s 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()
.
incrementToken
in class TokenStream
IOException
public void foldToASCII(char[] input, int length)
input
- The string to foldlength
- The number of characters in the input stringpublic static final int foldToASCII(char[] input, int inputPos, char[] output, int outputPos, int length)
input
- The characters to foldinputPos
- Index of the first character to foldoutput
- The result of the folding. Should be of size >= length * 4
.outputPos
- Index of output where to put the result of the foldinglength
- The number of characters to fold