public final class PatternReplaceFilter extends TokenFilter
Note: Depending on the input and the pattern used and the input TokenStream, this TokenFilter may produce Tokens whose text is the empty string.
Pattern
AttributeSource.AttributeFactory, AttributeSource.State
Constructor and Description |
---|
PatternReplaceFilter(TokenStream in,
Pattern p,
String replacement,
boolean all)
Constructs an instance to replace either the first, or all occurances
|
Modifier and Type | Method and Description |
---|---|
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 PatternReplaceFilter(TokenStream in, Pattern p, String replacement, boolean all)
in
- the TokenStream to processp
- the patterm to apply to each Tokenreplacement
- the "replacement string" to substitute, if null a
blank string will be used. Note that this is not the literal
string that will be used, '$' and '\' have special meaning.all
- if true, all matches will be replaced otherwise just the first match.Matcher.quoteReplacement(java.lang.String)
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
Copyright © 2010 - 2020 Adobe. All Rights Reserved