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 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 final void end()

  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.

  Overrides:

  end in class TokenStream

• 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 class Tokenizer

  Throws:

  IOException