CJKBigramFilter (Lucene 3.6.2 API)

java.lang.Object
- org.apache.lucene.util.AttributeSource
- - org.apache.lucene.analysis.TokenStream
  - - org.apache.lucene.analysis.TokenFilter
    - - org.apache.lucene.analysis.cjk.CJKBigramFilter

All Implemented Interfaces:

Closeable, AutoCloseable
```
public final class CJKBigramFilter
extends org.apache.lucene.analysis.TokenFilter
```
Forms bigrams of CJK terms that are generated from StandardTokenizer or ICUTokenizer.
CJK types are set by these tokenizers, but you can also use CJKBigramFilter(TokenStream, int) to explicitly control which of the CJK scripts are turned into bigrams.
In all cases, all non-CJK input is passed thru unmodified.

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
  org.apache.lucene.util.AttributeSource.AttributeFactory, org.apache.lucene.util.AttributeSource.State

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`DOUBLE_TYPE`	when we emit a bigram, its then marked as this type
`static int`	`HAN`	bigram flag for Han Ideographs
`static int`	`HANGUL`	bigram flag for Hangul
`static int`	`HIRAGANA`	bigram flag for Hiragana
`static int`	`KATAKANA`	bigram flag for Katakana
`static String`	`SINGLE_TYPE`	when we emit a unigram, its then marked as this type

Fields inherited from class org.apache.lucene.analysis.TokenFilter
input

Constructor Summary

Constructors
Constructor	Description
`CJKBigramFilter(org.apache.lucene.analysis.TokenStream in)`	Calls `CJKBigramFilter(HAN \| HIRAGANA \| KATAKANA \| HANGUL)`
`CJKBigramFilter(org.apache.lucene.analysis.TokenStream in, int flags)`	Create a new CJKBigramFilter, specifying which writing systems should be bigrammed.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

boolean incrementToken()

void 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, toString
- Methods inherited from class java.lang.Object
  clone, finalize, getClass, notify, notifyAll, wait, wait, wait
- Methods inherited from class org.apache.lucene.analysis.TokenFilter
  close, end

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`incrementToken()`
`void`	`reset()`

- Field Detail
  - HAN
```
public static final int HAN
```
    bigram flag for Han Ideographs
    
    See Also:
    
    Constant Field Values
  - HIRAGANA
```
public static final int HIRAGANA
```
    bigram flag for Hiragana
    
    See Also:
    
    Constant Field Values
  - KATAKANA
```
public static final int KATAKANA
```
    bigram flag for Katakana
    
    See Also:
    
    Constant Field Values
  - HANGUL
```
public static final int HANGUL
```
    bigram flag for Hangul
    
    See Also:
    
    Constant Field Values
  - DOUBLE_TYPE
```
public static final String DOUBLE_TYPE
```
    when we emit a bigram, its then marked as this type
    
    See Also:
    
    Constant Field Values
  - SINGLE_TYPE
```
public static final String SINGLE_TYPE
```
    when we emit a unigram, its then marked as this type
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CJKBigramFilter
```
public CJKBigramFilter(org.apache.lucene.analysis.TokenStream in)
```
    Calls CJKBigramFilter(HAN | HIRAGANA | KATAKANA | HANGUL)
  - CJKBigramFilter
```
public CJKBigramFilter(org.apache.lucene.analysis.TokenStream in,
                       int flags)
```
    Create a new CJKBigramFilter, specifying which writing systems should be bigrammed.
    
    Parameters:
    
    flags - OR'ed set from HAN, HIRAGANA, KATAKANA, HANGUL
- Method Detail
  - incrementToken
```
public boolean incrementToken()
                       throws IOException
```
    Specified by:
    
    incrementToken in class org.apache.lucene.analysis.TokenStream
    
    Throws:
    
    IOException
  - reset
```
public void reset()
           throws IOException
```
    Overrides:
    
    reset in class org.apache.lucene.analysis.TokenFilter
    
    Throws:
    
    IOException

Class CJKBigramFilter

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource

Field Summary

Fields inherited from class org.apache.lucene.analysis.TokenFilter

Constructor Summary

Method Summary

Methods inherited from class org.apache.lucene.util.AttributeSource

Methods inherited from class java.lang.Object

Methods inherited from class org.apache.lucene.analysis.TokenFilter

Field Detail

HAN

HIRAGANA

KATAKANA

HANGUL

DOUBLE_TYPE

SINGLE_TYPE

Constructor Detail

CJKBigramFilter

CJKBigramFilter

Method Detail

incrementToken

reset