public final class CapitalizationFilter extends TokenFilter
AttributeSource.AttributeFactory, AttributeSource.State
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_MAX_TOKEN_LENGTH |
static int |
DEFAULT_MAX_WORD_COUNT |
Constructor and Description |
---|
CapitalizationFilter(TokenStream in)
Creates a CapitalizationFilter with the default parameters.
|
CapitalizationFilter(TokenStream in,
boolean onlyFirstWord,
CharArraySet keep,
boolean forceFirstLetter,
Collection<char[]> okPrefix,
int minWordLength,
int maxWordCount,
int maxTokenLength)
Creates a CapitalizationFilter with the specified parameters.
|
Modifier and Type | Method and Description |
---|---|
boolean |
incrementToken()
Consumers (i.e.,
IndexWriter ) use this method to advance the stream to
the next token. |
close, end, reset
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString
public static final int DEFAULT_MAX_WORD_COUNT
public static final int DEFAULT_MAX_TOKEN_LENGTH
public CapitalizationFilter(TokenStream in)
public CapitalizationFilter(TokenStream in, boolean onlyFirstWord, CharArraySet keep, boolean forceFirstLetter, Collection<char[]> okPrefix, int minWordLength, int maxWordCount, int maxTokenLength)
in
- input tokenstreamonlyFirstWord
- should each word be capitalized or all of the words?keep
- a keep word list. Each word that should be kept separated by whitespace.forceFirstLetter
- Force the first letter to be capitalized even if it is in the keep list.okPrefix
- do not change word capitalization if a word begins with something in this list.minWordLength
- how long the word needs to be to get capitalization applied. If the
minWordLength is 3, "and" > "And" but "or" stays "or".maxWordCount
- if the token contains more then maxWordCount words, the capitalization is
assumed to be correct.maxTokenLength
- ???public boolean incrementToken() throws IOException
TokenStream
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()
.
incrementToken
in class TokenStream
IOException
Copyright © 2010 - 2020 Adobe. All Rights Reserved