Save This Page
Home » apache-solr-1.3.0 » org.apache.solr » analysis » [javadoc | source]
org.apache.solr.analysis
public interface: TokenFilterFactory [javadoc | source]

All Known Implementing Classes:
    GreekLowerCaseFilterFactory, SynonymFilterFactory, BrazilianStemFilterFactory, PatternReplaceFilterFactory, NumericPayloadTokenFilterFactory, EdgeNGramFilterFactory, ISOLatin1AccentFilterFactory, GermanStemFilterFactory, KeepWordFilterFactory, ChineseFilterFactory, EnglishPorterFilterFactory, RussianStemFilterFactory, PorterStemFilterFactory, SnowballPorterFilterFactory, StandardFilterFactory, HyphenatedWordsFilterFactory, PhoneticFilterFactory, DictionaryCompoundWordTokenFilterFactory, TokenOffsetPayloadTokenFilterFactory, LengthFilterFactory, ElisionFilterFactory, ThaiWordFilterFactory, DutchStemFilterFactory, ShingleFilterFactory, BaseTokenFilterFactory, RemoveDuplicatesTokenFilterFactory, LowerCaseFilterFactory, StopFilterFactory, CapitalizationFilterFactory, WordDelimiterFilterFactory, RussianLowerCaseFilterFactory, TypeAsPayloadTokenFilterFactory, TrimFilterFactory, NGramFilterFactory, FrenchStemFilterFactory

A TokenFilterFactory creates a TokenFilter to transform one TokenStream into another.

TokenFilterFactories are registered for FieldTypes with the IndexSchema through the schema.xml file.

Example schema.xml entry to register a TokenFilterFactory implementation to transform tokens in a field of type "cool"

<fieldtype name="cool" class="solr.TextField">
<analyzer>
...
<filter class="foo.MyTokenFilterFactory"/>
...

A single instance of any registered TokenFilterFactory is created via the default constructor and is reused for each FieldType.

Method from org.apache.solr.analysis.TokenFilterFactory Summary:
create,   getArgs,   init
Method from org.apache.solr.analysis.TokenFilterFactory Detail:
 public TokenStream create(TokenStream input)
    Transform the specified input TokenStream
 public Map getArgs()
    Accessor method for reporting the args used to initialize this factory.

    Implementations are strongly encouraged to return the contents of the Map passed to to the init method

 public  void init(Map args)
    init will be called just once, immediately after creation.

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