Class SynonymFilterFactory
- java.lang.Object
-
- org.apache.lucene.analysis.util.AbstractAnalysisFactory
-
- org.apache.lucene.analysis.util.TokenFilterFactory
-
- org.apache.lucene.analysis.synonym.SynonymFilterFactory
-
- All Implemented Interfaces:
ResourceLoaderAware
@Deprecated public class SynonymFilterFactory extends TokenFilterFactory implements ResourceLoaderAware
Deprecated.UseSynonymGraphFilterFactory
instead, but be sure to also useFlattenGraphFilterFactory
at index time (not at search time) as well.Factory forSynonymFilter
.<fieldType name="text_synonym" class="solr.TextField" positionIncrementGap="100"> <analyzer> <tokenizer class="solr.WhitespaceTokenizerFactory"/> <filter class="solr.SynonymFilterFactory" synonyms="synonyms.txt" format="solr" ignoreCase="false" expand="true" tokenizerFactory="solr.WhitespaceTokenizerFactory" [optional tokenizer factory parameters]/> </analyzer> </fieldType>
An optional param name prefix of "tokenizerFactory." may be used for any init params that the SynonymFilterFactory needs to pass to the specified TokenizerFactory. If the TokenizerFactory expects an init parameters with the same name as an init param used by the SynonymFilterFactory, the prefix is mandatory.
The optional
format
parameter controls how the synonyms will be parsed: It supports the short names ofsolr
forSolrSynonymParser
andwordnet
for andWordnetSynonymParser
, or your ownSynonymMap.Parser
class name. The default issolr
. A customSynonymMap.Parser
is expected to have a constructor taking:boolean dedup
- true if duplicates should be ignored, false otherwiseboolean expand
- true if conflation groups should be expanded, false if they are one-directional
- an analyzer used for each raw synonymAnalyzer
analyzer
- Since:
- 3.1
- See Also:
SolrSynonymParser: default format
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
analyzerName
Deprecated.private boolean
expand
Deprecated.private java.lang.String
format
Deprecated.private boolean
ignoreCase
Deprecated.private SynonymMap
map
Deprecated.static java.lang.String
NAME
Deprecated.SPI nameprivate java.lang.String
synonyms
Deprecated.private java.util.Map<java.lang.String,java.lang.String>
tokArgs
Deprecated.private java.lang.String
tokenizerFactory
Deprecated.-
Fields inherited from class org.apache.lucene.analysis.util.AbstractAnalysisFactory
LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion
-
-
Constructor Summary
Constructors Constructor Description SynonymFilterFactory(java.util.Map<java.lang.String,java.lang.String> args)
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TokenStream
create(TokenStream input)
Deprecated.Transform the specified input TokenStreamvoid
inform(ResourceLoader loader)
Deprecated.Initializes this component with the provided ResourceLoader (used for loading classes, files, etc).private Analyzer
loadAnalyzer(ResourceLoader loader, java.lang.String cname)
Deprecated.protected SynonymMap
loadSynonyms(ResourceLoader loader, java.lang.String cname, boolean dedup, Analyzer analyzer)
Deprecated.Load synonyms with the givenSynonymMap.Parser
class.private TokenizerFactory
loadTokenizerFactory(ResourceLoader loader, java.lang.String cname)
Deprecated.-
Methods inherited from class org.apache.lucene.analysis.util.TokenFilterFactory
availableTokenFilters, findSPIName, forName, lookupClass, normalize, reloadTokenFilters
-
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
-
-
-
-
Field Detail
-
NAME
public static final java.lang.String NAME
Deprecated.SPI name- See Also:
- Constant Field Values
-
ignoreCase
private final boolean ignoreCase
Deprecated.
-
tokenizerFactory
private final java.lang.String tokenizerFactory
Deprecated.
-
synonyms
private final java.lang.String synonyms
Deprecated.
-
format
private final java.lang.String format
Deprecated.
-
expand
private final boolean expand
Deprecated.
-
analyzerName
private final java.lang.String analyzerName
Deprecated.
-
tokArgs
private final java.util.Map<java.lang.String,java.lang.String> tokArgs
Deprecated.
-
map
private SynonymMap map
Deprecated.
-
-
Method Detail
-
create
public TokenStream create(TokenStream input)
Deprecated.Description copied from class:TokenFilterFactory
Transform the specified input TokenStream- Specified by:
create
in classTokenFilterFactory
-
inform
public void inform(ResourceLoader loader) throws java.io.IOException
Deprecated.Description copied from interface:ResourceLoaderAware
Initializes this component with the provided ResourceLoader (used for loading classes, files, etc).- Specified by:
inform
in interfaceResourceLoaderAware
- Throws:
java.io.IOException
-
loadSynonyms
protected SynonymMap loadSynonyms(ResourceLoader loader, java.lang.String cname, boolean dedup, Analyzer analyzer) throws java.io.IOException, java.text.ParseException
Deprecated.Load synonyms with the givenSynonymMap.Parser
class.- Throws:
java.io.IOException
java.text.ParseException
-
loadTokenizerFactory
private TokenizerFactory loadTokenizerFactory(ResourceLoader loader, java.lang.String cname) throws java.io.IOException
Deprecated.- Throws:
java.io.IOException
-
loadAnalyzer
private Analyzer loadAnalyzer(ResourceLoader loader, java.lang.String cname) throws java.io.IOException
Deprecated.- Throws:
java.io.IOException
-
-