org.apache.lucene.analysis

Class PrefixAnalyzer.PrefixTokenFilter

java.lang.Object

org.apache.lucene.util.AttributeSource

org.apache.lucene.analysis.TokenStream

org.apache.lucene.analysis.TokenFilter

org.apache.lucene.analysis.PrefixAnalyzer.PrefixTokenFilter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Enclosing class:

PrefixAnalyzer

public static final class PrefixAnalyzer.PrefixTokenFilter
extends org.apache.lucene.analysis.TokenFilter

The PrefixAnalyzer.PrefixTokenFilter wraps a TokenStream and adds a set prefixes ahead. The position attribute will not be incremented for the prefixes.

Nested Class Summary

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

org.apache.lucene.util.AttributeSource.State

Field Summary

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

input

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

DEFAULT_TOKEN_ATTRIBUTE_FACTORY

Constructor Summary

Constructors

Constructor and Description
PrefixTokenFilter(org.apache.lucene.analysis.TokenStream input, char separator, java.lang.Iterable<? extends java.lang.CharSequence> prefixes) Create a new PrefixAnalyzer.PrefixTokenFilter.

Method Summary

Modifier and Type	Method and Description
boolean	incrementToken()
void	reset()

Methods inherited from class org.apache.lucene.analysis.TokenFilter

close, end

Methods inherited from class org.apache.lucene.util.AttributeSource

addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, endAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, removeAllAttributes, restoreState, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PrefixTokenFilter

public PrefixTokenFilter(org.apache.lucene.analysis.TokenStream input,
                         char separator,
                         java.lang.Iterable<? extends java.lang.CharSequence> prefixes)

Create a new PrefixAnalyzer.PrefixTokenFilter. The separator will be set to the DEFAULT_SEPARATOR.

Parameters:

input - TokenStream to wrap

separator - Character used separate prefixes from other tokens

prefixes - Iterable of CharSequence which keeps all prefixes

Method Detail

incrementToken

public boolean incrementToken()
                       throws java.io.IOException

Specified by:

incrementToken in class org.apache.lucene.analysis.TokenStream

Throws:

java.io.IOException

reset

public void reset()
           throws java.io.IOException

Overrides:

reset in class org.apache.lucene.analysis.TokenFilter

Throws:

java.io.IOException