Class PatternReplaceCharFilter

Lucene.Net.Analysis.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

Inheritance
object
MarshalByRefObject
TextReader
CharFilter
BaseCharFilter
PatternReplaceCharFilter
Implements
Inherited Members
CharFilter.m_input
CharFilter.Reset()
CharFilter.IsReady
CharFilter.IsMarkSupported
Namespace: Lucene.Net.Analysis.Pattern
Assembly: Lucene.Net.Analysis.Common.dll
Syntax
public class PatternReplaceCharFilter : BaseCharFilter, IDisposable

Constructors

PatternReplaceCharFilter(Regex, string, TextReader)

Lucene.Net.Analysis.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

Declaration
public PatternReplaceCharFilter(Regex pattern, string replacement, TextReader @in)
Parameters
Type Name Description
Regex pattern
string replacement
TextReader in

PatternReplaceCharFilter(Regex, string, int, string, TextReader)

Lucene.Net.Analysis.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

Declaration
[Obsolete]
public PatternReplaceCharFilter(Regex pattern, string replacement, int maxBlockChars, string blockDelimiter, TextReader @in)
Parameters
Type Name Description
Regex pattern
string replacement
int maxBlockChars
string blockDelimiter
TextReader in

Fields

DEFAULT_MAX_BLOCK_CHARS

Lucene.Net.Analysis.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

Declaration
[Obsolete]
public const int DEFAULT_MAX_BLOCK_CHARS = 10000
Field Value
Type Description
int

Methods

Correct(int)

Retrieve the corrected offset.

Declaration
protected override int Correct(int currentOff)
Parameters
Type Name Description
int currentOff
Returns
Type Description
int
Overrides

Read()

Reads the next character from the text reader and advances the character position by one character.

Declaration
public override int Read()
Returns
Type Description
int

The next character from the text reader, or -1 if no more characters are available. The default implementation returns -1.
Overrides
Lucene.Net.Analysis.CharFilter.Read()
Exceptions
Type Condition
ObjectDisposedException

The TextReader is closed.
IOException

An I/O error occurs.

Read(char[], int, int)

Reads a specified maximum number of characters from the current reader and writes the data to a buffer, beginning at the specified index.

Declaration
public override int Read(char[] cbuf, int off, int len)
Parameters
Type Name Description
char[] cbuf
int off
int len
Returns
Type Description
int

The number of characters that have been read. The number will be less than or equal to count, depending on whether the data is available within the reader. This method returns 0 (zero) if it is called when no more characters are left to read.
Overrides
Exceptions
Type Condition
ArgumentNullException

buffer is null.
ArgumentException

The buffer length minus index is less than count.
ArgumentOutOfRangeException

index or count is negative.
ObjectDisposedException

The TextReader is closed.
IOException

An I/O error occurs.

Implements