public final class ASCIIFoldingFilter extends TokenFilter
AttributeSource.AttributeFactory, AttributeSource.State| Constructor and Description |
|---|
ASCIIFoldingFilter(TokenStream input) |
ASCIIFoldingFilter(TokenStream input,
boolean preserveOriginal)
Create a new
ASCIIFoldingFilter. |
| 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. |
boolean |
isPreserveOriginal()
Does the filter preserve the original tokens?
|
void |
reset()
This method is called by a consumer before it begins consumption using
TokenStream.incrementToken(). |
close, endaddAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toStringpublic ASCIIFoldingFilter(TokenStream input)
public ASCIIFoldingFilter(TokenStream input, boolean preserveOriginal)
ASCIIFoldingFilter.input - TokenStream to filterpreserveOriginal - should the original tokens be kept on the input stream with a 0 position increment
from the folded tokens?public boolean isPreserveOriginal()
public boolean incrementToken()
throws IOException
TokenStreamIndexWriter) 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().
incrementToken in class TokenStreamIOExceptionpublic void reset()
throws IOException
TokenFilterTokenStream.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.
reset in class TokenFilterIOExceptionpublic 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 foldCopyright © 2010 - 2020 Adobe. All Rights Reserved