Package org.apache.solr.rest.schema.analysis

Class ManagedSynonymGraphFilterFactory

java.lang.Object

org.apache.lucene.analysis.AbstractAnalysisFactory

org.apache.lucene.analysis.TokenFilterFactory

org.apache.solr.rest.schema.analysis.BaseManagedTokenFilterFactory

org.apache.solr.rest.schema.analysis.ManagedSynonymGraphFilterFactory

All Implemented Interfaces:

org.apache.lucene.util.ResourceLoaderAware, ManagedResourceObserver

public class ManagedSynonymGraphFilterFactory
extends BaseManagedTokenFilterFactory

TokenFilterFactory and ManagedResource implementation for doing CRUD on synonyms using the REST API.

Since:

7.0.0

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

"managedSynonymGraph"

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ManagedSynonymGraphFilterFactory.SynonymManager	ManagedResource implementation for synonyms, which are so specialized that it makes sense to implement this class as an inner class as it has little application outside the SynonymFilterFactory use cases.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.lucene.analysis.synonym.SynonymGraphFilterFactory	delegate
static String	IGNORE_CASE_INIT_ARG
static String	NAME	SPI name
static String	SYNONYM_MAPPINGS

Fields inherited from class org.apache.solr.rest.schema.analysis.BaseManagedTokenFilterFactory

handle

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

LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion

Constructor Summary

Constructors

Constructor	Description
ManagedSynonymGraphFilterFactory()	Default ctor for compatibility with SPI
ManagedSynonymGraphFilterFactory(Map<String,String> args)

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.analysis.TokenStream	create(org.apache.lucene.analysis.TokenStream input)
protected Class<? extends ManagedResource>	getManagedResourceImplClass()	Let the concrete analysis component determine the ManagedResource implementation.
String	getResourceId()	Let the concrete analysis component decide the path it wishes to be managed at.
void	onManagedResourceInitialized(org.apache.solr.common.util.NamedList<?> initArgs, ManagedResource res)	Called once, during core initialization, to initialize any analysis components that depend on the data managed by this resource.

Methods inherited from class org.apache.solr.rest.schema.analysis.BaseManagedTokenFilterFactory

inform

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

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

SYNONYM_MAPPINGS

public static final String SYNONYM_MAPPINGS

See Also:

Constant Field Values

IGNORE_CASE_INIT_ARG

public static final String IGNORE_CASE_INIT_ARG

See Also:

Constant Field Values

delegate

protected org.apache.lucene.analysis.synonym.SynonymGraphFilterFactory delegate

Constructor Detail

ManagedSynonymGraphFilterFactory

public ManagedSynonymGraphFilterFactory(Map<String,String> args)

ManagedSynonymGraphFilterFactory

public ManagedSynonymGraphFilterFactory()

Default ctor for compatibility with SPI

Method Detail

getResourceId

public String getResourceId()

Description copied from class: BaseManagedTokenFilterFactory

Let the concrete analysis component decide the path it wishes to be managed at.

Specified by:

getResourceId in class BaseManagedTokenFilterFactory

getManagedResourceImplClass

protected Class<? extends ManagedResource> getManagedResourceImplClass()

Description copied from class: BaseManagedTokenFilterFactory

Let the concrete analysis component determine the ManagedResource implementation. As there can be many instances of the same analysis component in a schema, this class should not presume to create ManagedResource. For instance, there may be 10 instances of the ManagedStopFilterFactory that use the same set of English stop words and we don't want 10 copies of the ManagedWordSetResource in the same core.

Specified by:

getManagedResourceImplClass in class BaseManagedTokenFilterFactory

onManagedResourceInitialized

public void onManagedResourceInitialized(org.apache.solr.common.util.NamedList<?> initArgs,
                                         ManagedResource res)
                                  throws org.apache.solr.common.SolrException

Called once, during core initialization, to initialize any analysis components that depend on the data managed by this resource. It is important that the analysis component is only initialized once during core initialization so that text analysis is consistent, especially in a distributed environment, as we don't want one server applying a different set of stop words than other servers.

Throws:

org.apache.solr.common.SolrException

create

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

Specified by:

create in class org.apache.lucene.analysis.TokenFilterFactory