Class ASCIIFoldingFilter

This class converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if one exists.

Characters from the following Unicode blocks are converted; however, only those characters with reasonable ASCII alternatives are converted:

See: http://en.wikipedia.org/wiki/Latin_characters_in_Unicode

For example, 'à' will be replaced by 'a'.

Inheritance
System.Object
AttributeSource
TokenStream
TokenFilter
ASCIIFoldingFilter
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Lucene.Net.Analysis.Miscellaneous
Assembly: Lucene.Net.Analysis.Common.dll
Syntax
public sealed class ASCIIFoldingFilter : TokenFilter, IDisposable

Constructors

| Improve this Doc View Source

ASCIIFoldingFilter(TokenStream)

Declaration
public ASCIIFoldingFilter(TokenStream input)
Parameters
Type Name Description
TokenStream input
| Improve this Doc View Source

ASCIIFoldingFilter(TokenStream, Boolean)

Create a new ASCIIFoldingFilter.

Declaration
public ASCIIFoldingFilter(TokenStream input, bool preserveOriginal)
Parameters
Type Name Description
TokenStream input

TokenStream to filter

System.Boolean preserveOriginal

should the original tokens be kept on the input stream with a 0 position increment from the folded tokens?

Properties

| Improve this Doc View Source

PreserveOriginal

Does the filter preserve the original tokens?

Declaration
public bool PreserveOriginal { get; }
Property Value
Type Description
System.Boolean

Methods

| Improve this Doc View Source

FoldToASCII(Char[], Int32)

Converts characters above ASCII to their ASCII equivalents. For example, accents are removed from accented characters.

Declaration
public void FoldToASCII(char[] input, int length)
Parameters
Type Name Description
System.Char[] input

The string to fold

System.Int32 length

The number of characters in the input string

| Improve this Doc View Source

FoldToASCII(Char[], Int32, Char[], Int32, Int32)

Converts characters above ASCII to their ASCII equivalents. For example, accents are removed from accented characters.

This is a Lucene.NET INTERNAL API, use at your own risk
Declaration
public static int FoldToASCII(char[] input, int inputPos, char[] output, int outputPos, int length)
Parameters
Type Name Description
System.Char[] input

The characters to fold

System.Int32 inputPos

Index of the first character to fold

System.Char[] output

The result of the folding. Should be of size >= length * 4.

System.Int32 outputPos

Index of output where to put the result of the folding

System.Int32 length

The number of characters to fold

Returns
Type Description
System.Int32

length of output

| Improve this Doc View Source

IncrementToken()

Declaration
public override bool IncrementToken()
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

Reset()

Declaration
public override void Reset()
Overrides

Implements

System.IDisposable