Class PatternReplaceFilter

  extended by org.apache.lucene.util.AttributeSource
      extended by org.apache.lucene.analysis.TokenStream
          extended by org.apache.lucene.analysis.TokenFilter
              extended by org.apache.lucene.analysis.pattern.PatternReplaceFilter
All Implemented Interfaces:

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:

Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.AttributeFactory, AttributeSource.State
Field Summary
Fields inherited from class org.apache.lucene.analysis.TokenFilter
Constructor Summary
PatternReplaceFilter(TokenStream in, Pattern p, String replacement, boolean all)
          Constructs an instance to replace either the first, or all occurances
Method Summary
 boolean incrementToken()
Methods inherited from class org.apache.lucene.analysis.TokenFilter
close, end, reset
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
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public PatternReplaceFilter(TokenStream in,
                            Pattern p,
                            String replacement,
                            boolean all)
Constructs an instance to replace either the first, or all occurances

in - the TokenStream to process
p - the patterm to apply to each Token
replacement - 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:
Method Detail


public boolean incrementToken()
                       throws IOException
Specified by:
incrementToken in class TokenStream

Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.