Package org.apache.lucene.analysis.pattern

Class PatternReplaceCharFilter

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable
    public class PatternReplaceCharFilter
extends BaseCharFilter
    CharFilter that uses a regular expression for the target of replace string. The pattern match will be done in each "block" in char stream.

    ex1) source="aa  bb aa bb", pattern="(aa)\\s+(bb)" replacement="$1#$2"
    output="aa#bb aa#bb"

    NOTE: If you produce a phrase that has different length to source string and the field is used for highlighting for a term of the phrase, you will face a trouble.

    ex2) source="aa123bb", pattern="(aa)\\d+(bb)" replacement="$1 $2"
    output="aa bb"
    and you want to search bb and highlight it, you will get
    highlight snippet="aa1<em>23bb</em>"

    Since:
    Solr 1.5

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.regex.Pattern pattern  
      private java.lang.String replacement  
      private java.io.Reader transformedInput  

      • Fields inherited from class java.io.Reader

        lock

    • Constructor Summary

      Constructors 
      Constructor Description
      PatternReplaceCharFilter​(java.util.regex.Pattern pattern, java.lang.String replacement, java.io.Reader in)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected int correct​(int currentOff)
      Retrieve the corrected offset.
      private void fill()  
      (package private) java.lang.CharSequence processPattern​(java.lang.CharSequence input)
      Replace pattern in input and mark correction offsets.
      int read()  
      int read​(char[] cbuf, int off, int len)  

      • Methods inherited from class java.io.Reader

        mark, markSupported, nullReader, read, read, ready, reset, skip, transferTo

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • pattern

        private final java.util.regex.Pattern pattern

      • replacement

        private final java.lang.String replacement

      • transformedInput

        private java.io.Reader transformedInput

    • Constructor Detail

      • PatternReplaceCharFilter

        public PatternReplaceCharFilter​(java.util.regex.Pattern pattern,
                                java.lang.String replacement,
                                java.io.Reader in)

    • Method Detail

      • read

        public int read​(char[] cbuf,
                int off,
                int len)
         throws java.io.IOException
        Specified by:
        read in class java.io.Reader
        Throws:
        java.io.IOException

      • fill

        private void fill()
           throws java.io.IOException
        Throws:
        java.io.IOException

      • read

        public int read()
         throws java.io.IOException
        Overrides:
        read in class java.io.Reader
        Throws:
        java.io.IOException

      • correct

        protected int correct​(int currentOff)
        Description copied from class: BaseCharFilter
        Retrieve the corrected offset.
        Overrides:
        correct in class BaseCharFilter
        Parameters:
        currentOff - current offset
        Returns:
        corrected offset

      • processPattern

        java.lang.CharSequence processPattern​(java.lang.CharSequence input)
        Replace pattern in input and mark correction offsets.