Class SynonymFilterFactory
java.lang.Object
org.apache.lucene.analysis.AbstractAnalysisFactory
org.apache.lucene.analysis.TokenFilterFactory
org.apache.lucene.analysis.synonym.SynonymFilterFactory
- All Implemented Interfaces:
ResourceLoaderAware
@Deprecated
public class SynonymFilterFactory
extends TokenFilterFactory
implements ResourceLoaderAware
Deprecated.
Factory for
SynonymFilter
.
<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 of solr
for SolrSynonymParser
and wordnet
for and WordnetSynonymParser
, or your own SynonymMap.Parser
class name. The default is
solr
. A custom SynonymMap.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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final String
Deprecated.private final boolean
Deprecated.private final String
Deprecated.private final boolean
Deprecated.private SynonymMap
Deprecated.static final String
Deprecated.SPI nameprivate final String
Deprecated.Deprecated.private final String
Deprecated.Fields inherited from class org.apache.lucene.analysis.AbstractAnalysisFactory
LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion
-
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.Default ctor for compatibility with SPISynonymFilterFactory
(Map<String, String> args) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptioncreate
(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, String cname) Deprecated.protected SynonymMap
loadSynonyms
(ResourceLoader loader, String cname, boolean dedup, Analyzer analyzer) Deprecated.Load synonyms with the givenSynonymMap.Parser
class.private TokenizerFactory
loadTokenizerFactory
(ResourceLoader loader, String cname) Deprecated.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
-
Field Details
-
NAME
Deprecated.SPI name- See Also:
-
ignoreCase
private final boolean ignoreCaseDeprecated. -
tokenizerFactory
Deprecated. -
synonyms
Deprecated. -
format
Deprecated. -
expand
private final boolean expandDeprecated. -
analyzerName
Deprecated. -
tokArgs
Deprecated. -
map
Deprecated.
-
-
Constructor Details
-
SynonymFilterFactory
Deprecated. -
SynonymFilterFactory
public SynonymFilterFactory()Deprecated.Default ctor for compatibility with SPI
-
-
Method Details
-
create
Deprecated.Description copied from class:TokenFilterFactory
Transform the specified input TokenStream- Specified by:
create
in classTokenFilterFactory
-
inform
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:
IOException
-
loadSynonyms
protected SynonymMap loadSynonyms(ResourceLoader loader, String cname, boolean dedup, Analyzer analyzer) throws IOException, ParseException Deprecated.Load synonyms with the givenSynonymMap.Parser
class.- Throws:
IOException
ParseException
-
loadTokenizerFactory
private TokenizerFactory loadTokenizerFactory(ResourceLoader loader, String cname) throws IOException Deprecated.- Throws:
IOException
-
loadAnalyzer
Deprecated.- Throws:
IOException
-
SynonymGraphFilterFactory
instead, but be sure to also useFlattenGraphFilterFactory
at index time (not at search time) as well.