org.apache.lucene.search.suggest.document

Class CompletionTokenStream

java.lang.Object

org.apache.lucene.util.AttributeSource

org.apache.lucene.analysis.TokenStream

org.apache.lucene.search.suggest.document.CompletionTokenStream

All Implemented Interfaces:

Closeable, AutoCloseable

public final class CompletionTokenStream
extends TokenStream

Token stream which converts a provided token stream to an automaton. The accepted strings enumeration from the automaton are available through the TermToBytesRefAttribute attribute The token stream uses a PayloadAttribute to store a completion's payload (see setPayload(org.apache.lucene.util.BytesRef))

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompletionTokenStream.BytesRefBuilderTermAttributeImpl Custom attribute implementation for completion token stream

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

AttributeSource.State

Field Summary

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

DEFAULT_TOKEN_ATTRIBUTE_FACTORY

Method Summary

Modifier and Type	Method and Description
void	close() Releases resources associated with this stream.
void	end() This method is called by the consumer after the last token has been consumed, after TokenStream.incrementToken() returned false (using the new TokenStream API).
boolean	incrementToken() Consumers (i.e., IndexWriter) use this method to advance the stream to the next token.
void	reset() This method is called by a consumer before it begins consumption using TokenStream.incrementToken().
void	setPayload(BytesRef payload) Sets a payload available throughout successive token stream enumeration
Automaton	toAutomaton() Converts the token stream to an automaton, treating the transition labels as utf-8
Automaton	toAutomaton(boolean unicodeAware) Converts the tokenStream to an automaton

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

Method Detail

setPayload

public void setPayload(BytesRef payload)

Sets a payload available throughout successive token stream enumeration

incrementToken

public 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 appropriate AttributeImpls 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 AttributeImpls 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:

IOException

end

public void end()
         throws IOException

Description copied from class: TokenStream

This method is called by the consumer after the last token has been consumed, after TokenStream.incrementToken() returned false (using the new TokenStream 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 a WhitespaceTokenizer was used.

Additionally any skipped positions (such as those removed by a stopfilter) can be applied to the position increment, or any adjustment of other attributes where the end-of-stream value may be important.

If you override this method, always call super.end().

Overrides:

end in class TokenStream

Throws:

IOException - If an I/O error occurs

close

public void close()
           throws IOException

Description copied from class: TokenStream

Releases resources associated with this stream.

If you override this method, always call super.close(), otherwise some internal state will not be correctly reset (e.g., Tokenizer will throw IllegalStateException on reuse).

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class TokenStream

Throws:

IOException

reset

public void reset()
           throws IOException

Description copied from class: TokenStream

This method is called by a consumer before it begins consumption using 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).

Overrides:

reset in class TokenStream

Throws:

IOException

toAutomaton

public Automaton toAutomaton()
                      throws IOException

Converts the token stream to an automaton, treating the transition labels as utf-8

Throws:

IOException

toAutomaton

public Automaton toAutomaton(boolean unicodeAware)
                      throws IOException

Converts the tokenStream to an automaton

Throws:

IOException