public final class

LowerCaseFilter

extends TokenFilter
java.lang.Object
   ↳ org.apache.lucene.util.AttributeSource
     ↳ org.apache.lucene.analysis.TokenStream
       ↳ org.apache.lucene.analysis.TokenFilter
         ↳ org.apache.lucene.analysis.LowerCaseFilter

Class Overview

Normalizes token text to lower case.

Summary

[Expand]
Inherited Fields
From class org.apache.lucene.analysis.TokenFilter
Public Constructors
LowerCaseFilter(TokenStream in)
Public Methods
final boolean incrementToken()
Consumers (i.e., IndexWriter) use this method to advance the stream to the next token.
[Expand]
Inherited Methods
From class org.apache.lucene.analysis.TokenFilter
From class org.apache.lucene.analysis.TokenStream
From class org.apache.lucene.util.AttributeSource
From class java.lang.Object
From interface java.io.Closeable

Public Constructors

public LowerCaseFilter (TokenStream in)

Public Methods

public final boolean incrementToken ()

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 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 addAttribute(Class) and 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 incrementToken().

Returns
  • false for end of stream; true otherwise
Throws
IOException