org.apache.lucene.analysis.pattern
Class PatternReplaceFilter
java.lang.Object
org.apache.lucene.util.AttributeSource
org.apache.lucene.analysis.TokenStream
org.apache.lucene.analysis.TokenFilter
org.apache.lucene.analysis.pattern.PatternReplaceFilter
- All Implemented Interfaces:
- Closeable
public final class PatternReplaceFilter
- extends TokenFilter
A TokenFilter which applies a Pattern to each token in the stream,
replacing match occurances with the specified replacement string.
Note: Depending on the input and the pattern used and the input
TokenStream, this TokenFilter may produce Tokens whose text is the empty
string.
- See Also:
Pattern
Methods inherited from class org.apache.lucene.util.AttributeSource |
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState |
PatternReplaceFilter
public PatternReplaceFilter(TokenStream in,
Pattern p,
String replacement,
boolean all)
- Constructs an instance to replace either the first, or all occurances
- Parameters:
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.- See Also:
Matcher.quoteReplacement(java.lang.String)
incrementToken
public boolean incrementToken()
throws IOException
- Specified by:
incrementToken
in class TokenStream
- Throws:
IOException
Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.