Dear Wiki user, You have subscribed to a wiki page or wiki category on "Solr Wiki" for change notification.
The "SolrPlugins" page has been changed by AlanWoodward: http://wiki.apache.org/solr/SolrPlugins?action=diff&rev1=44&rev2=45 Comment: Correct Javadoc links == Request Processing == === SolrRequestHandler === - Instances of [[http://lucene.apache.org/solr/docs/api/org/apache/solr/request/SolrRequestHandler.html|SolrRequestHandler]] define the logic that is executed for any request. Multiple handlers (including multiple instances of the same !SolrRequestHandler class with different configurations) can be specified in your [[SolrConfigXml|solrconfig.xml]]... + Instances of [[http://lucene.apache.org/solr/api/org/apache/solr/request/SolrRequestHandler.html|SolrRequestHandler]] define the logic that is executed for any request. Multiple handlers (including multiple instances of the same !SolrRequestHandler class with different configurations) can be specified in your [[SolrConfigXml|solrconfig.xml]]... {{{ <requestHandler name="foo" class="my.package.CustomRequestHandler" /> @@ -111, +111 @@ See UpdateRequestProcessor === QueryResponseWriter === - Instances of [[http://lucene.apache.org/solr/docs/api/org/apache/solr/request/QueryResponseWriter.html|QueryResponseWriter]] define the formatting used to output the results of a request. Multiple writers (including multiple instances of the same !QueryResponseWriter class with different configurations) can be specified in your [[SolrConfigXml|solrconfig.xml]]... + Instances of [[http://lucene.apache.org/solr/api/org/apache/solr/request/QueryResponseWriter.html|QueryResponseWriter]] define the formatting used to output the results of a request. Multiple writers (including multiple instances of the same !QueryResponseWriter class with different configurations) can be specified in your [[SolrConfigXml|solrconfig.xml]]... {{{ <queryResponseWriter name="wow" class="my.package.CustomResponseWriter" /> @@ -122, +122 @@ </queryResponseWriter> }}} === Similarity === - The [[http://lucene.apache.org/java/docs/api/org/apache/lucene/search/Similarity.html|Similarity]] class is a native Lucene concept that determines how much of the score calculations for the various types of queries are executed. For more information on how the methods in the Similarity class are used, consult the [[http://lucene.apache.org/java/2_9_0/scoring.html|Lucene scoring documentation]]. If you wish to override the !DefaultSimilarity provided by Lucene, you can specify your own subclass in your [[SchemaXml|schema.xml]]... + The [[http://lucene.apache.org/core/3_6_0/api/core/org/apache/lucene/search/Similarity.html|Similarity]] class is a native Lucene concept that determines how much of the score calculations for the various types of queries are executed. For more information on how the methods in the Similarity class are used, consult the [[http://lucene.apache.org/java/2_9_0/scoring.html|Lucene scoring documentation]]. If you wish to override the !DefaultSimilarity provided by Lucene, you can specify your own subclass in your [[SchemaXml|schema.xml]]... {{{ <similarity class="my.package.CustomSimilarity"/> }}} === CacheRegenerator === - The [[http://lucene.apache.org/solr/docs/api/org/apache/solr/search/CacheRegenerator.html|CacheRegenerator]] API allows people who are writing custom !SolrRequestHandlers which utilize custom [[SolrCaching|User Caches]] to specify how those caches should be populated during autowarming. A regenerator class can be specified when the cache is declared in your [[SolrConfigXml|solrconfig.xml]]... + The [[http://lucene.apache.org/solr/api/org/apache/solr/search/CacheRegenerator.html|CacheRegenerator]] API allows people who are writing custom !SolrRequestHandlers which utilize custom [[SolrCaching|User Caches]] to specify how those caches should be populated during autowarming. A regenerator class can be specified when the cache is declared in your [[SolrConfigXml|solrconfig.xml]]... {{{ <cache name="myCustomCacheInstance" @@ -141, +141 @@ }}} == Fields == === Analyzer === - The [[http://lucene.apache.org/java/docs/api/org/apache/lucene/analysis/Analyzer.html|Analyzer]] class is a native Lucene concept that determines how tokens are produced from a piece of text. Solr allows Analyzers to be specified for each fieldtype in your [[SchemaXml|schema.xml]] that uses the !TextField class -- and even allows for different Analyzers to be specified for indexing text as documents are added, and parsing text specified in a query... + The [[http://lucene.apache.org/core/3_6_0/api/core/org/apache/lucene/analysis/Analyzer.html|Analyzer]] class is a native Lucene concept that determines how tokens are produced from a piece of text. Solr allows Analyzers to be specified for each fieldtype in your [[SchemaXml|schema.xml]] that uses the !TextField class -- and even allows for different Analyzers to be specified for indexing text as documents are added, and parsing text specified in a query... {{{ <fieldtype name="text_foo" class="solr.TextField"> @@ -152, +152 @@ <analyzer type="query" class="my.package.CustomAnalyzerForQuering"/> </fieldType> }}} - Solr also provides a [[http://lucene.apache.org/solr/docs/api/org/apache/solr/analysis/SolrAnalyzer.html|SolrAnalyzer]] base class which can be used if you want to write your own Analyzer and configure the "positionIncrementGap" in your schema.xml... + Solr also provides a [[http://lucene.apache.org/solr/api/org/apache/solr/analysis/SolrAnalyzer.html|SolrAnalyzer]] base class which can be used if you want to write your own Analyzer and configure the "positionIncrementGap" in your schema.xml... {{{ <fieldtype name="text_baz" class="solr.TextField" positionIncrementGap="100"> @@ -162, +162 @@ Specifying an Analyzer class in your schema.xml makes a lot of sense if you already have an existing Analyzer you wish to use as is, but if you are planning to write Analysis code from scratch that you would like to use in Solr, you should keep reading the following sections... === Tokenizer and TokenFilter === - In addition to specifing specific Analyzer classes, Solr can construct Analyzers on the fly for each field type using a [[http://lucene.apache.org/java/docs/api/org/apache/lucene/analysis/Tokenizer.html|Tokenizer]] and any number of [[http://lucene.apache.org/java/docs/api/org/apache/lucene/analysis/TokenFilter.html|TokenFilters]]. To take advantage of this functionality with any Tokenizers or !TokenFilters you may have (or may want to implement) you'll need to provide a [[http://lucene.apache.org/solr/docs/api/org/apache/solr/analysis/TokenizerFactory.html|TokenizerFactory]] and [[http://lucene.apache.org/solr/docs/api/org/apache/solr/analysis/TokenFilterFactory.html|TokenFilterFactory]] which takes care of any initialization and configuration, and specify these Factories in your [[SchemaXml|schema.xml]]... + In addition to specifing specific Analyzer classes, Solr can construct Analyzers on the fly for each field type using a [[http://lucene.apache.org/core/3_6_0/api/core/org/apache/lucene/analysis/Tokenizer.html|Tokenizer]] and any number of [[http://lucene.apache.org/core/3_6_0/api/core/org/apache/lucene/analysis/TokenFilter.html|TokenFilters]]. To take advantage of this functionality with any Tokenizers or !TokenFilters you may have (or may want to implement) you'll need to provide a [[http://lucene.apache.org/solr/api/org/apache/solr/analysis/TokenizerFactory.html|TokenizerFactory]] and [[http://lucene.apache.org/solr/api/org/apache/solr/analysis/TokenFilterFactory.html|TokenFilterFactory]] which takes care of any initialization and configuration, and specify these Factories in your [[SchemaXml|schema.xml]]... {{{ <fieldtype name="text_zop" class="solr.TextField" positionIncrementGap="100"> @@ -176, +176 @@ </fieldtype> }}} === FieldType === - If you have very specialized data type needs, you can specify your own [[http://lucene.apache.org/solr/docs/api/org/apache/solr/schema/FieldType.html|FieldType]] class for each <`fieldtype>` you declare in your [[SchemaXml|schema.xml]], to control how the values for those fields are encoded in your index... + If you have very specialized data type needs, you can specify your own [[http://lucene.apache.org/solr/api/org/apache/solr/schema/FieldType.html|FieldType]] class for each <`fieldtype>` you declare in your [[SchemaXml|schema.xml]], to control how the values for those fields are encoded in your index... {{{ <fieldtype name="wacko" class="my.package.CustomFieldType" /> }}} == Internals == === SolrCache === - The [[http://lucene.apache.org/solr/docs/api/org/apache/solr/search/SolrCache.html|SolrCache]] API allows you to specify custom Cache implementations for any of the [[SolrCaching|various caches]] you might declare in your [[SolrConfigXml|solrconfig.xml]]... + The [[http://lucene.apache.org/solr/api/org/apache/solr/search/SolrCache.html|SolrCache]] API allows you to specify custom Cache implementations for any of the [[SolrCaching|various caches]] you might declare in your [[SolrConfigXml|solrconfig.xml]]... {{{ <filterCache class="my.package.CustomCache" size="512" /> @@ -191, +191 @@ <documentCache class="my.package.AlternateCustomCache" size="512" /> }}} === SolrEventListener === - Instances of the [[http://lucene.apache.org/solr/docs/api/org/apache/solr/core/SolrEventListener.html|SolrEventListener]] Interface can be configured in your [[SolrConfigXml|solrconfig.xml]] to be be executed any time specific events occur within Solr. + Instances of the [[http://lucene.apache.org/solr/api/org/apache/solr/core/SolrEventListener.html|SolrEventListener]] Interface can be configured in your [[SolrConfigXml|solrconfig.xml]] to be be executed any time specific events occur within Solr. `firstSearcher` and `newSearcher` events trigger the `newSearcher()` method with the appropriate args, `postCommit` and `postOptimize` events will trigger the `postCommit()` method... @@ -205, +205 @@ </listener> }}} === UpdateHandler === - The [[http://lucene.apache.org/solr/docs/api/org/apache/solr/update/UpdateHandler.html|UpdateHandler]] API allows you to specify a custom algorithm for determining how sequences of adds and deletes are processed by Solr. The !UpdateHandler you wish to use can be configured in your [[SolrConfigXml|solrconfig.xml]], but implementing a new !UpdateHandler is considered '''extremely''' advanced and is not recommended.... + The [[http://lucene.apache.org/solr/api/org/apache/solr/update/UpdateHandler.html|UpdateHandler]] API allows you to specify a custom algorithm for determining how sequences of adds and deletes are processed by Solr. The !UpdateHandler you wish to use can be configured in your [[SolrConfigXml|solrconfig.xml]], but implementing a new !UpdateHandler is considered '''extremely''' advanced and is not recommended.... {{{ <updateHandler class="my.package.CustomUpdateHandler"> @@ -216, +216 @@ = Plugin Initialization = <!> [[Solr1.3]] - Plugins are initialized either with [[http://svn.apache.org/repos/asf/lucene/dev/trunk/solr/src/java/org/apache/solr/util/plugin/MapInitializedPlugin.java|init( Map<String,String> args )]] or [[http://svn.apache.org/repos/asf/lucene/dev/trunk/solr/src/java/org/apache/solr/util/plugin/NamedListInitializedPlugin.java|init( NamedList args )]]. + Plugins are initialized either with [[http://lucene.apache.org/solr/api/org/apache/solr/util/plugin/MapInitializedPlugin.html|init( Map<String,String> args )]] or [[http://lucene.apache.org/solr/api/org/apache/solr/util/plugin/NamedListInitializedPlugin.html|init( NamedList args )]]. <!> [[Solr1.4]] - Plugins can also be initialized with [[http://svn.apache.org/repos/asf/lucene/dev/trunk/solr/src/java/org/apache/solr/util/plugin/PluginInfoInitialized.java|init( PluginInfo info )]]. These Plugins can have children ( any Subnode with a "class" attribute is considered a child ). + Plugins can also be initialized with [[http://lucene.apache.org/solr/api/org/apache/solr/util/plugin/PluginInfoInitialized.html|init( PluginInfo info )]]. These Plugins can have children ( any Subnode with a "class" attribute is considered a child ). If a pluginInfoInitialized Plugin wants to initialise these children in its {{{inform( core )}}} method via {{{ core.create.createInitInstance() }}}, the children must not be !SolrCoreAware. - see [[http://svn.apache.org/repos/asf/lucene/dev/trunk/solr/src/java/org/apache/solr/core/PluginInfo.java|PluginInfo]]. + see [[http://lucene.apache.org/solr/api/org/apache/solr/core/PluginInfo.html|PluginInfo]]. <!> [[Solr3.1]] As of Solr3.1 any subnode which is not a "lst","str","int","bool","arr","float" or "double" is considered a child. (Yes "long" is missing - see SOLR-2541) == ResourceLoaderAware == - Classes that need to know about the [[http://svn.apache.org/repos/asf/lucene/dev/trunk/solr/src/common/org/apache/solr/common/ResourceLoader.java|ResourceLoader]] can implement [[http://svn.apache.org/repos/asf/lucene/dev/trunk/solr/src/java/org/apache/solr/util/plugin/ResourceLoaderAware.java|ResourceLoaderAware]]. Valid !ResourceLoaderAware include: + Classes that need to know about the [[http://lucene.apache.org/solr/api/org/apache/solr/common/ResourceLoader.html|ResourceLoader]] can implement [[http://lucene.apache.org/solr/api/org/apache/solr/util/plugin/ResourceLoaderAware.html|ResourceLoaderAware]]. Valid !ResourceLoaderAware include: * !TokenFilterFactory * !TokenizerFactory * !FieldType == SolrCoreAware == - Classes that need to know about the [SolrCore] can implement [[http://svn.apache.org/repos/asf/lucene/dev/trunk/solr/src/java/org/apache/solr/util/plugin/SolrCoreAware.java|SolrCoreAware]]. Classes implementing !SolrCoreAware must not have a dedicated Constructor. Valid !SolrCoreAware classes include: + Classes that need to know about the [SolrCore] can implement [[http://lucene.apache.org/solr/api/org/apache/solr/util/plugin/SolrCoreAware.html|SolrCoreAware]]. Classes implementing !SolrCoreAware must not have a dedicated Constructor. Valid !SolrCoreAware classes include: * SolrRequestHandler * QueryResponseWriter
