org.apache.lucene.analysis.cn.smart
Class WordTokenFilter
java.lang.Object
org.apache.lucene.util.AttributeSource
org.apache.lucene.analysis.TokenStream
org.apache.lucene.analysis.TokenFilter
org.apache.lucene.analysis.cn.smart.WordTokenFilter
- All Implemented Interfaces:
- java.io.Closeable
public final class WordTokenFilter
- extends TokenFilter
A TokenFilter
that breaks sentences into words.
WARNING: The status of the analyzers/smartcn analysis.cn.smart package is experimental.
The APIs and file formats introduced here might change in the future and will not be
supported anymore in such a case.
Method Summary |
boolean |
incrementToken()
Consumers (i.e., IndexWriter ) use this method to advance the stream to
the next token. |
void |
reset()
Reset the filter as well as the input TokenStream. |
Methods inherited from class org.apache.lucene.util.AttributeSource |
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, restoreState, toString |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
WordTokenFilter
public WordTokenFilter(TokenStream in)
- Construct a new WordTokenizer.
- Parameters:
in
- TokenStream
of sentences
incrementToken
public boolean incrementToken()
throws java.io.IOException
- Description copied from class:
TokenStream
- Consumers (i.e.,
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()
.
- Specified by:
incrementToken
in class TokenStream
- Returns:
- false for end of stream; true otherwise
- Throws:
java.io.IOException
reset
public void reset()
throws java.io.IOException
- Description copied from class:
TokenFilter
- Reset the filter as well as the input TokenStream.
- Overrides:
reset
in class TokenFilter
- Throws:
java.io.IOException
Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.