Class JapaneseIterationMarkCharFilter

Normalizes Japanese horizontal iteration marks (odoriji) to their expanded form.

Inheritance
System.Object
CharFilter
JapaneseIterationMarkCharFilter
Inherited Members
Namespace: Lucene.Net.Analysis.Ja
Assembly: Lucene.Net.Analysis.Kuromoji.dll
Syntax
public class JapaneseIterationMarkCharFilter : CharFilter
Remarks

Sequences of iteration marks are supported. In case an illegal sequence of iteration marks is encountered, the implementation emits the illegal source character as-is without considering its script. For example, with input "?ゝ", we get "??" even though "?" isn't hiragana.

Note that a full stop punctuation character "。" (U+3002) can not be iterated (see below). Iteration marks themselves can be emitted in case they are illegal, i.e. if they go back past the beginning of the character stream.

The implementation buffers input until a full stop punctuation character (U+3002) or EOF is reached in order to not keep a copy of the character stream in memory. Vertical iteration marks, which are even rarer than horizontal iteration marks in contemporary Japanese, are unsupported.

Constructors

| Improve this Doc View Source

JapaneseIterationMarkCharFilter(TextReader)

Constructor. Normalizes both kanji and kana iteration marks by default.

Declaration
public JapaneseIterationMarkCharFilter(TextReader input)
Parameters
Type Name Description
TextReader input

Char stream.
| Improve this Doc View Source

JapaneseIterationMarkCharFilter(TextReader, Boolean, Boolean)

Constructor

Declaration
public JapaneseIterationMarkCharFilter(TextReader input, bool normalizeKanji, bool normalizeKana)
Parameters
Type Name Description
TextReader input

Char stream.
System.Boolean normalizeKanji

Indicates whether kanji iteration marks should be normalized.
System.Boolean normalizeKana

Indicates whether kana iteration marks should be normalized.

Fields

| Improve this Doc View Source

NORMALIZE_KANA_DEFAULT

Normalize kana iteration marks by default

Declaration
public static readonly bool NORMALIZE_KANA_DEFAULT
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

NORMALIZE_KANJI_DEFAULT

Normalize kanji iteration marks by default

Declaration
public static readonly bool NORMALIZE_KANJI_DEFAULT
Field Value
Type Description
System.Boolean

Methods

| Improve this Doc View Source

Correct(Int32)

Declaration
protected override int Correct(int currentOff)
Parameters
Type Name Description
System.Int32 currentOff
Returns
Type Description
System.Int32
| Improve this Doc View Source

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
System.Int32

The next character from the text reader, or -1 if no more characters are available.
Overrides
| Improve this Doc View Source

Read(Char[], Int32, Int32)

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[] buffer, int offset, int length)
Parameters
Type Name Description
System.Char[] buffer

When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.
System.Int32 offset

The position in buffer at which to begin writing.
System.Int32 length

The maximum number of characters to read. If the end of the reader is reached before the specified number of characters is read into the buffer, the method returns.
Returns
Type Description
System.Int32

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.