org.apache.solr.analysis

Class PositionFilterFactory

java.lang.Object

org.apache.solr.analysis.BaseTokenStreamFactory

org.apache.solr.analysis.BaseTokenFilterFactory

org.apache.solr.analysis.PositionFilterFactory

All Implemented Interfaces:

TokenFilterFactory

public class PositionFilterFactory
extends BaseTokenFilterFactory

Factory for PositionFilter. Set the positionIncrement of all tokens to the "positionIncrement", except the first return token which retains its original positionIncrement value. The default positionIncrement value is zero.

 <fieldType name="text_position" class="solr.TextField" positionIncrementGap="100">
   <analyzer>
     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
     <filter class="solr.PositionFilterFactory" positionIncrement="0"/>
   </analyzer>
 </fieldType>

Since:

solr 1.4

Version:

$Id: PositionFilterFactory.java 1074023 2011-02-24 02:25:08Z koji $

See Also:

PositionFilter

Field Summary

Fields

Modifier and Type	Field and Description
private int	positionIncrement

Fields inherited from class org.apache.solr.analysis.BaseTokenFilterFactory

log

Fields inherited from class org.apache.solr.analysis.BaseTokenStreamFactory

args, luceneMatchVersion

Constructor Summary

Constructors

Constructor and Description
PositionFilterFactory()

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.analysis.position.PositionFilter	create(org.apache.lucene.analysis.TokenStream input) Transform the specified input TokenStream
void	init(java.util.Map<java.lang.String,java.lang.String> args) init will be called just once, immediately after creation.

Methods inherited from class org.apache.solr.analysis.BaseTokenStreamFactory

assureMatchVersion, getArgs, getBoolean, getBoolean, getInt, getInt, getInt, getSnowballWordSet, getWordSet, warnDeprecated

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.solr.analysis.TokenFilterFactory

getArgs

Field Detail

positionIncrement

private int positionIncrement

Constructor Detail

PositionFilterFactory

public PositionFilterFactory()

Method Detail

init

public void init(java.util.Map<java.lang.String,java.lang.String> args)

Description copied from interface: TokenFilterFactory

init will be called just once, immediately after creation.

The args are user-level initialization parameters that may be specified when declaring the factory in the schema.xml

Specified by:

init in interface TokenFilterFactory

Overrides:

init in class BaseTokenStreamFactory

create

public org.apache.lucene.analysis.position.PositionFilter create(org.apache.lucene.analysis.TokenStream input)

Description copied from interface: TokenFilterFactory

Transform the specified input TokenStream