Module org.apache.lucene.analysis.common

Package org.apache.lucene.analysis.miscellaneous

Class LimitTokenPositionFilterFactory

java.lang.Object

org.apache.lucene.analysis.AbstractAnalysisFactory

org.apache.lucene.analysis.TokenFilterFactory

org.apache.lucene.analysis.miscellaneous.LimitTokenPositionFilterFactory

public class LimitTokenPositionFilterFactory
extends TokenFilterFactory

Factory for LimitTokenPositionFilter.

 <fieldType name="text_limit_pos" class="solr.TextField" positionIncrementGap="100">
   <analyzer>
     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
     <filter class="solr.LimitTokenPositionFilterFactory" maxTokenPosition="3" consumeAllTokens="false" />
   </analyzer>
 </fieldType>

The consumeAllTokens property is optional and defaults to false. See LimitTokenPositionFilter for an explanation of its use.

Since:

4.3.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONSUME_ALL_TOKENS_KEY
(package private) final boolean	consumeAllTokens
static final String	MAX_TOKEN_POSITION_KEY
(package private) final int	maxTokenPosition
static final String	NAME	SPI name

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

LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion

Constructor Summary

Constructors

Constructor	Description
LimitTokenPositionFilterFactory()	Default ctor for compatibility with SPI
LimitTokenPositionFilterFactory(Map<String,String> args)	Creates a new LimitTokenPositionFilterFactory

Method Summary

Modifier and Type	Method	Description
TokenStream	create(TokenStream input)	Transform the specified input TokenStream

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

availableTokenFilters, findSPIName, forName, lookupClass, normalize, reloadTokenFilters

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

defaultCtorException, get, get, get, get, get, getBoolean, getChar, getClassArg, getFloat, getInt, getLines, getLuceneMatchVersion, getOriginalArgs, getPattern, getSet, getSnowballWordSet, getWordSet, isExplicitLuceneMatchVersion, require, require, require, requireBoolean, requireChar, requireFloat, requireInt, setExplicitLuceneMatchVersion, splitAt, splitFileNames

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

SPI name

See Also:

• Constant Field Values

MAX_TOKEN_POSITION_KEY

public static final String MAX_TOKEN_POSITION_KEY

See Also:

• Constant Field Values

CONSUME_ALL_TOKENS_KEY

public static final String CONSUME_ALL_TOKENS_KEY

See Also:

• Constant Field Values

maxTokenPosition

final int maxTokenPosition

consumeAllTokens

final boolean consumeAllTokens

Constructor Details

LimitTokenPositionFilterFactory

public LimitTokenPositionFilterFactory(Map<String,String> args)

Creates a new LimitTokenPositionFilterFactory

LimitTokenPositionFilterFactory

public LimitTokenPositionFilterFactory()

Default ctor for compatibility with SPI

Method Details

create

public TokenStream create(TokenStream input)

Description copied from class: TokenFilterFactory

Transform the specified input TokenStream

Specified by:

create in class TokenFilterFactory