Module org.apache.lucene.analysis.common

Package org.apache.lucene.analysis.payloads

Class NumericPayloadTokenFilterFactory

java.lang.Object

org.apache.lucene.analysis.AbstractAnalysisFactory

org.apache.lucene.analysis.TokenFilterFactory

org.apache.lucene.analysis.payloads.NumericPayloadTokenFilterFactory

public class NumericPayloadTokenFilterFactory
extends TokenFilterFactory

Factory for NumericPayloadTokenFilter.

 <fieldType name="text_numpayload" class="solr.TextField" positionIncrementGap="100">
   <analyzer>
     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
     <filter class="solr.NumericPayloadTokenFilterFactory" payload="24" typeMatch="word"/>
   </analyzer>
 </fieldType>

Since:

3.1

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	SPI name
private final float	payload
private final String	typeMatch

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

LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
NumericPayloadTokenFilter	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

payload

private final float payload

typeMatch

private final String typeMatch

Constructor Details

NumericPayloadTokenFilterFactory

public NumericPayloadTokenFilterFactory(Map<String,String> args)

Creates a new NumericPayloadTokenFilterFactory

NumericPayloadTokenFilterFactory

public NumericPayloadTokenFilterFactory()

Default ctor for compatibility with SPI

Method Details

create

public NumericPayloadTokenFilter create(TokenStream input)

Description copied from class: TokenFilterFactory

Transform the specified input TokenStream

Specified by:

create in class TokenFilterFactory