Package org.apache.lucene.analysis.payloads

Class TokenOffsetPayloadTokenFilterFactory

java.lang.Object

org.apache.lucene.analysis.AbstractAnalysisFactory

org.apache.lucene.analysis.TokenFilterFactory

org.apache.lucene.analysis.payloads.TokenOffsetPayloadTokenFilterFactory

public class TokenOffsetPayloadTokenFilterFactory
extends TokenFilterFactory

Factory for TokenOffsetPayloadTokenFilter.

 <fieldType name="text_tokenoffset" class="solr.TextField" positionIncrementGap="100">
   <analyzer>
     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
     <filter class="solr.TokenOffsetPayloadTokenFilterFactory"/>
   </analyzer>
 </fieldType>

Since:

3.1

SPI Name (case-insensitive: if the name is 'htmlStrip', 'htmlstrip' can be used when looking up the service).

"tokenOffsetPayload"

Field Summary

Fields

Modifier and Type	Field	Description
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
TokenOffsetPayloadTokenFilterFactory()	Default ctor for compatibility with SPI
TokenOffsetPayloadTokenFilterFactory(Map<String,String> args)	Creates a new TokenOffsetPayloadTokenFilterFactory

Method Summary

Modifier and Type	Method	Description
TokenOffsetPayloadTokenFilter	create(TokenStream input)

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

Constructor Details

TokenOffsetPayloadTokenFilterFactory

public TokenOffsetPayloadTokenFilterFactory(Map<String,String> args)

Creates a new TokenOffsetPayloadTokenFilterFactory

TokenOffsetPayloadTokenFilterFactory

public TokenOffsetPayloadTokenFilterFactory()

Default ctor for compatibility with SPI

Method Details

create

public TokenOffsetPayloadTokenFilter create(TokenStream input)

Specified by:

create in class TokenFilterFactory