Class KeywordTokenizer
- java.lang.Object
-
- org.apache.lucene.util.AttributeSource
-
- org.apache.lucene.analysis.TokenStream
-
- org.apache.lucene.analysis.Tokenizer
-
- org.apache.lucene.analysis.KeywordTokenizer
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
public final class KeywordTokenizer extends Tokenizer
Emits the entire input as a single token.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.AttributeFactory, AttributeSource.State
-
-
Constructor Summary
Constructors Constructor Description KeywordTokenizer(Reader input)
KeywordTokenizer(Reader input, int bufferSize)
KeywordTokenizer(AttributeSource.AttributeFactory factory, Reader input, int bufferSize)
KeywordTokenizer(AttributeSource source, Reader input, int bufferSize)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
end()
This method is called by the consumer after the last token has been consumed, afterTokenStream.incrementToken()
returnedfalse
(using the newTokenStream
API).boolean
incrementToken()
Consumers (i.e.,IndexWriter
) use this method to advance the stream to the next token.void
reset(Reader input)
Expert: Reset the tokenizer to a new reader.-
Methods inherited from class org.apache.lucene.analysis.Tokenizer
close, correctOffset
-
Methods inherited from class org.apache.lucene.analysis.TokenStream
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
-
-
-
-
Constructor Detail
-
KeywordTokenizer
public KeywordTokenizer(Reader input)
-
KeywordTokenizer
public KeywordTokenizer(Reader input, int bufferSize)
-
KeywordTokenizer
public KeywordTokenizer(AttributeSource source, Reader input, int bufferSize)
-
KeywordTokenizer
public KeywordTokenizer(AttributeSource.AttributeFactory factory, Reader input, int bufferSize)
-
-
Method Detail
-
incrementToken
public final boolean incrementToken() throws 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 appropriateAttributeImpl
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)
andAttributeSource.getAttribute(Class)
, references to allAttributeImpl
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 classTokenStream
- Returns:
- false for end of stream; true otherwise
- Throws:
IOException
-
end
public final void end()
Description copied from class:TokenStream
This method is called by the consumer after the last token has been consumed, afterTokenStream.incrementToken()
returnedfalse
(using the newTokenStream
API). Streams implementing the old API should upgrade to use this feature. This method can be used to perform any end-of-stream operations, such as setting the final offset of a stream. The final offset of a stream might differ from the offset of the last token eg in case one or more whitespaces followed after the last token, but aWhitespaceTokenizer
was used.- Overrides:
end
in classTokenStream
-
reset
public void reset(Reader input) throws IOException
Description copied from class:Tokenizer
Expert: Reset the tokenizer to a new reader. Typically, an analyzer (in its reusableTokenStream method) will use this to re-use a previously created tokenizer.- Overrides:
reset
in classTokenizer
- Throws:
IOException
-
-