public final class CJKBigramFilter extends TokenFilter
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.
By default, when a CJK character has no adjacent characters to form
a bigram, it is output in unigram form. If you want to always output
both unigrams and bigrams, set the outputUnigrams
flag in CJKBigramFilter(TokenStream, int, boolean)
.
This can be used for a combined unigram+bigram approach.
Unlike ICUTokenizer, StandardTokenizer does not split at script boundaries.
Korean Hangul characters are treated the same as many other scripts'
letters, and as a result, StandardTokenizer can produce tokens that mix
Hangul and non-Hangul characters, e.g. "한국abc". Such mixed-script tokens
are typed as <ALPHANUM>
rather than
<HANGUL>
, and as a result, will not be converted to
bigrams by CJKBigramFilter.
In all cases, all non-CJK input is passed thru unmodified.
AttributeSource.State
Modifier and Type | Field and Description |
---|---|
(package private) int[] |
buffer |
(package private) int |
bufferLen |
private java.lang.Object |
doHan |
private java.lang.Object |
doHangul |
private java.lang.Object |
doHiragana |
private java.lang.Object |
doKatakana |
static java.lang.String |
DOUBLE_TYPE
when we emit a bigram, it's then marked as this type
|
(package private) int[] |
endOffset |
private boolean |
exhausted |
static int |
HAN
bigram flag for Han Ideographs
|
private static java.lang.String |
HAN_TYPE |
static int |
HANGUL
bigram flag for Hangul
|
private static java.lang.String |
HANGUL_TYPE |
static int |
HIRAGANA
bigram flag for Hiragana
|
private static java.lang.String |
HIRAGANA_TYPE |
(package private) int |
index |
static int |
KATAKANA
bigram flag for Katakana
|
private static java.lang.String |
KATAKANA_TYPE |
(package private) int |
lastEndOffset |
private AttributeSource.State |
loneState |
private boolean |
ngramState |
private static java.lang.Object |
NO |
private OffsetAttribute |
offsetAtt |
private boolean |
outputUnigrams |
private PositionIncrementAttribute |
posIncAtt |
private PositionLengthAttribute |
posLengthAtt |
static java.lang.String |
SINGLE_TYPE
when we emit a unigram, it's then marked as this type
|
(package private) int[] |
startOffset |
private CharTermAttribute |
termAtt |
private TypeAttribute |
typeAtt |
input
DEFAULT_TOKEN_ATTRIBUTE_FACTORY
Constructor and Description |
---|
CJKBigramFilter(TokenStream in)
|
CJKBigramFilter(TokenStream in,
int flags)
|
CJKBigramFilter(TokenStream in,
int flags,
boolean outputUnigrams)
Create a new CJKBigramFilter, specifying which writing systems should be bigrammed,
and whether or not unigrams should also be output.
|
Modifier and Type | Method and Description |
---|---|
private boolean |
doNext()
looks at next input token, returning false is none is available
|
private void |
flushBigram()
Flushes a bigram token to output from our buffer
This is the normal case, e.g.
|
private void |
flushUnigram()
Flushes a unigram token to output from our buffer.
|
private boolean |
hasBufferedBigram()
True if we have multiple codepoints sitting in our buffer
|
private boolean |
hasBufferedUnigram()
True if we have a single codepoint sitting in our buffer, where its future
(whether it is emitted as unigram or forms a bigram) depends upon not-yet-seen
inputs.
|
boolean |
incrementToken()
Consumers (i.e.,
IndexWriter ) use this method to advance the stream to
the next token. |
private void |
refill()
refills buffers with new data from the current token.
|
void |
reset()
This method is called by a consumer before it begins consumption using
TokenStream.incrementToken() . |
close, end
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, endAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, removeAllAttributes, restoreState, toString
public static final int HAN
public static final int HIRAGANA
public static final int KATAKANA
public static final int HANGUL
public static final java.lang.String DOUBLE_TYPE
public static final java.lang.String SINGLE_TYPE
private static final java.lang.String HAN_TYPE
private static final java.lang.String HIRAGANA_TYPE
private static final java.lang.String KATAKANA_TYPE
private static final java.lang.String HANGUL_TYPE
private static final java.lang.Object NO
private final java.lang.Object doHan
private final java.lang.Object doHiragana
private final java.lang.Object doKatakana
private final java.lang.Object doHangul
private final boolean outputUnigrams
private boolean ngramState
private final CharTermAttribute termAtt
private final TypeAttribute typeAtt
private final OffsetAttribute offsetAtt
private final PositionIncrementAttribute posIncAtt
private final PositionLengthAttribute posLengthAtt
int[] buffer
int[] startOffset
int[] endOffset
int bufferLen
int index
int lastEndOffset
private boolean exhausted
private AttributeSource.State loneState
public CJKBigramFilter(TokenStream in)
public CJKBigramFilter(TokenStream in, int flags)
public CJKBigramFilter(TokenStream in, int flags, boolean outputUnigrams)
public boolean incrementToken() throws java.io.IOException
TokenStream
IndexWriter
) use this method to advance the stream to
the next token. Implementing classes must implement this method and update
the appropriate AttributeImpl
s with the attributes of the next
token.
The producer must make no assumptions about the attributes after the method
has been returned: the caller may arbitrarily change it. If the producer
needs to preserve the state for subsequent calls, it can use
AttributeSource.captureState()
to create a copy of the current attribute state.
This method is called for every token of a document, so an efficient
implementation is crucial for good performance. To avoid calls to
AttributeSource.addAttribute(Class)
and AttributeSource.getAttribute(Class)
,
references to all AttributeImpl
s that this stream uses should be
retrieved during instantiation.
To ensure that filters and consumers know which attributes are available,
the attributes must be added during instantiation. Filters and consumers
are not required to check for availability of attributes in
TokenStream.incrementToken()
.
incrementToken
in class TokenStream
java.io.IOException
private boolean doNext() throws java.io.IOException
java.io.IOException
private void refill()
private void flushBigram()
private void flushUnigram()
private boolean hasBufferedBigram()
private boolean hasBufferedUnigram()
public void reset() throws java.io.IOException
TokenFilter
TokenStream.incrementToken()
.
Resets this stream to a clean state. Stateful implementations must implement this method so that they can be reused, just as if they had been created fresh.
If you override this method, always call super.reset()
, otherwise
some internal state will not be correctly reset (e.g., Tokenizer
will
throw IllegalStateException
on further usage).
NOTE:
The default implementation chains the call to the input TokenStream, so
be sure to call super.reset()
when overriding this method.
reset
in class TokenFilter
java.io.IOException