mirror of https://github.com/apache/lucene.git
better javadocs for UpdateRequestProcessorChain and the key processor factories people should always know about
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1365857 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
436175cfaf
commit
64dcd8855d
|
@ -21,6 +21,11 @@ import org.apache.solr.common.util.NamedList;
|
||||||
import org.apache.solr.request.SolrQueryRequest;
|
import org.apache.solr.request.SolrQueryRequest;
|
||||||
import org.apache.solr.response.SolrQueryResponse;
|
import org.apache.solr.response.SolrQueryResponse;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Factory for {@link DistributedUpdateProcessor}.
|
||||||
|
*
|
||||||
|
* @see DistributedUpdateProcessor
|
||||||
|
*/
|
||||||
public class DistributedUpdateProcessorFactory
|
public class DistributedUpdateProcessorFactory
|
||||||
extends UpdateRequestProcessorFactory
|
extends UpdateRequestProcessorFactory
|
||||||
implements DistributingUpdateProcessorFactory {
|
implements DistributingUpdateProcessorFactory {
|
||||||
|
|
|
@ -23,7 +23,8 @@ import org.apache.solr.common.SolrException;
|
||||||
* A marker interface for denoting that a factory is responsible for handling
|
* A marker interface for denoting that a factory is responsible for handling
|
||||||
* distributed communication of updates across a SolrCloud cluster.
|
* distributed communication of updates across a SolrCloud cluster.
|
||||||
*
|
*
|
||||||
* @see UpdateRequestProcessorChain
|
* @see UpdateRequestProcessorChain#init
|
||||||
|
* @see UpdateRequestProcessorChain#createProcessor
|
||||||
*/
|
*/
|
||||||
public interface DistributingUpdateProcessorFactory {
|
public interface DistributingUpdateProcessorFactory {
|
||||||
|
|
||||||
|
|
|
@ -35,12 +35,15 @@ import org.slf4j.Logger;
|
||||||
import org.slf4j.LoggerFactory;
|
import org.slf4j.LoggerFactory;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* <p>
|
||||||
* A logging processor. This keeps track of all commands that have passed through
|
* A logging processor. This keeps track of all commands that have passed through
|
||||||
* the chain and prints them on finish(). At the Debug (FINE) level, a message
|
* the chain and prints them on finish(). At the Debug (FINE) level, a message
|
||||||
* will be logged for each command prior to the next stage in the chain.
|
* will be logged for each command prior to the next stage in the chain.
|
||||||
*
|
* </p>
|
||||||
* If the Log level is not >= INFO the processor will not be created or added to the chain.
|
* <p>
|
||||||
*
|
* If the Log level is not >= INFO the processor will not be created or added to the chain.
|
||||||
|
* </p>
|
||||||
|
*
|
||||||
* @since solr 1.3
|
* @since solr 1.3
|
||||||
*/
|
*/
|
||||||
public class LogUpdateProcessorFactory extends UpdateRequestProcessorFactory {
|
public class LogUpdateProcessorFactory extends UpdateRequestProcessorFactory {
|
||||||
|
|
|
@ -25,9 +25,14 @@ import org.apache.solr.update.*;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Pass the command to the UpdateHandler without any modifications
|
* Executes the update commands using the underlying UpdateHandler.
|
||||||
|
* Allmost all processor chains should end with an instance of
|
||||||
|
* <code>RunUpdateProcessorFactory</code> unless the user is explicitly
|
||||||
|
* executing the update commands in an alternative custom
|
||||||
|
* <code>UpdateRequestProcessorFactory</code>
|
||||||
*
|
*
|
||||||
* @since solr 1.3
|
* @since solr 1.3
|
||||||
|
* @see DistributingUpdateProcessorFactory
|
||||||
*/
|
*/
|
||||||
public class RunUpdateProcessorFactory extends UpdateRequestProcessorFactory
|
public class RunUpdateProcessorFactory extends UpdateRequestProcessorFactory
|
||||||
{
|
{
|
||||||
|
|
|
@ -36,7 +36,7 @@ import java.util.ArrayList;
|
||||||
* <p>
|
* <p>
|
||||||
* Chain can be configured via solrconfig.xml:
|
* Chain can be configured via solrconfig.xml:
|
||||||
* </p>
|
* </p>
|
||||||
* <pre>
|
* <pre class="prettyprint">
|
||||||
* <updateRequestProcessors name="key" default="true">
|
* <updateRequestProcessors name="key" default="true">
|
||||||
* <processor class="PathToClass1" />
|
* <processor class="PathToClass1" />
|
||||||
* <processor class="PathToClass2" />
|
* <processor class="PathToClass2" />
|
||||||
|
@ -46,9 +46,16 @@ import java.util.ArrayList;
|
||||||
* <processor class="solr.RunUpdateProcessorFactory" />
|
* <processor class="solr.RunUpdateProcessorFactory" />
|
||||||
* </updateRequestProcessors>
|
* </updateRequestProcessors>
|
||||||
* </pre>
|
* </pre>
|
||||||
|
* <p>
|
||||||
|
* Allmost all processor chains should end with an instance of
|
||||||
|
* {@link RunUpdateProcessorFactory} unless the user is explicitly
|
||||||
|
* executing the update commands in an alternative custom
|
||||||
|
* <code>UpdateRequestProcessorFactory</code>.
|
||||||
|
* </p>
|
||||||
*
|
*
|
||||||
* @see UpdateRequestProcessorFactory
|
* @see UpdateRequestProcessorFactory
|
||||||
* @see #init
|
* @see #init
|
||||||
|
* @see #createProcessor
|
||||||
* @since solr 1.3
|
* @since solr 1.3
|
||||||
*/
|
*/
|
||||||
public final class UpdateRequestProcessorChain implements PluginInfoInitialized
|
public final class UpdateRequestProcessorChain implements PluginInfoInitialized
|
||||||
|
|
Loading…
Reference in New Issue