org.apache.lucene.analysis.charfilter

Class MappingCharFilterFactory

java.lang.Object

org.apache.lucene.analysis.util.AbstractAnalysisFactory

org.apache.lucene.analysis.util.CharFilterFactory

org.apache.lucene.analysis.charfilter.MappingCharFilterFactory

All Implemented Interfaces:

ResourceLoaderAware

public class MappingCharFilterFactory
extends CharFilterFactory
implements ResourceLoaderAware

Factory for MappingCharFilter.

 <fieldType name="text_map" class="solr.TextField" positionIncrementGap="100">
   <analyzer>
     <charFilter class="solr.MappingCharFilterFactory" mapping="mapping.txt"/>
     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
   </analyzer>
 </fieldType>

Since:

Solr 1.4

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

"mapping"

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME SPI name
protected NormalizeCharMap	normMap

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

LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion

Constructor Summary

Constructors

Constructor and Description
MappingCharFilterFactory(Map<String,String> args) Creates a new MappingCharFilterFactory

Method Summary

Modifier and Type	Method and Description
Reader	create(Reader input) Wraps the given Reader with a CharFilter.
void	inform(ResourceLoader loader) Initializes this component with the provided ResourceLoader (used for loading classes, files, etc).
Reader	normalize(Reader input) Normalize the specified input Reader While the default implementation returns input unchanged, char filters that should be applied at normalization time can delegate to create method.
protected void	parseRules(List<String> rules, NormalizeCharMap.Builder builder)
protected String	parseString(String s)

Methods inherited from class org.apache.lucene.analysis.util.CharFilterFactory

availableCharFilters, findSPIName, forName, lookupClass, reloadCharFilters

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

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 Detail

NAME

public static final String NAME

SPI name

See Also:

Constant Field Values

normMap

protected NormalizeCharMap normMap

Constructor Detail

MappingCharFilterFactory

public MappingCharFilterFactory(Map<String,String> args)

Creates a new MappingCharFilterFactory

Method Detail

inform

public void inform(ResourceLoader loader)
            throws IOException

Description copied from interface: ResourceLoaderAware

Initializes this component with the provided ResourceLoader (used for loading classes, files, etc).

Specified by:

inform in interface ResourceLoaderAware

Throws:

IOException

create

public Reader create(Reader input)

Description copied from class: CharFilterFactory

Wraps the given Reader with a CharFilter.

Specified by:

create in class CharFilterFactory

normalize

public Reader normalize(Reader input)

Description copied from class: CharFilterFactory

Normalize the specified input Reader While the default implementation returns input unchanged, char filters that should be applied at normalization time can delegate to create method.

Overrides:

normalize in class CharFilterFactory

parseRules

protected void parseRules(List<String> rules,
                          NormalizeCharMap.Builder builder)

parseString

protected String parseString(String s)