Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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:
Chris M. Hostetter 2012-07-26 00:50:40 +00:00
parent 436175cfaf
commit 64dcd8855d
5 changed files with 27 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
solr/core/src/java/org/apache/solr/update/processor/DistributedUpdateProcessorFactory.java
View File

@ -21,6 +21,11 @@ import org.apache.solr.common.util.NamedList;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.response.SolrQueryResponse;
/**
* Factory for {@link DistributedUpdateProcessor}.
*
* @see DistributedUpdateProcessor
*/
public class DistributedUpdateProcessorFactory
extends UpdateRequestProcessorFactory
implements DistributingUpdateProcessorFactory {

3
solr/core/src/java/org/apache/solr/update/processor/DistributingUpdateProcessorFactory.java
View File

@ -23,7 +23,8 @@ import org.apache.solr.common.SolrException;
* A marker interface for denoting that a factory is responsible for handling
* distributed communication of updates across a SolrCloud cluster.
*
* @see UpdateRequestProcessorChain
* @see UpdateRequestProcessorChain#init
* @see UpdateRequestProcessorChain#createProcessor
*/
public interface DistributingUpdateProcessorFactory {

9
solr/core/src/java/org/apache/solr/update/processor/LogUpdateProcessorFactory.java
View File

@ -35,12 +35,15 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* <p>
* 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
* will be logged for each command prior to the next stage in the chain.
*
* If the Log level is not >= INFO the processor will not be created or added to the chain.
*
* </p>
* <p>
* If the Log level is not &gt;= INFO the processor will not be created or added to the chain.
* </p>
*
* @since solr 1.3
*/
public class LogUpdateProcessorFactory extends UpdateRequestProcessorFactory {

7
solr/core/src/java/org/apache/solr/update/processor/RunUpdateProcessorFactory.java
View File

@ -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
* @see DistributingUpdateProcessorFactory
*/
public class RunUpdateProcessorFactory extends UpdateRequestProcessorFactory
{

9
solr/core/src/java/org/apache/solr/update/processor/UpdateRequestProcessorChain.java
View File

@ -36,7 +36,7 @@ import java.util.ArrayList;
* <p>
* Chain can be configured via solrconfig.xml:
* </p>
* <pre>
* <pre class="prettyprint">
* &lt;updateRequestProcessors name="key" default="true"&gt;
* &lt;processor class="PathToClass1" /&gt;
* &lt;processor class="PathToClass2" /&gt;
@ -46,9 +46,16 @@ import java.util.ArrayList;
* &lt;processor class="solr.RunUpdateProcessorFactory" /&gt;
* &lt;/updateRequestProcessors&gt;
* </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 #init
* @see #createProcessor
* @since solr 1.3
*/
public final class UpdateRequestProcessorChain implements PluginInfoInitialized