From 12b30db6ce8d3e3b6a3eea8f63fd19c8501e770e Mon Sep 17 00:00:00 2001
From: Robert Muir A data source implementation which can be used to read binary stream from content streams. Refer to A data source implementation which can be used to read binary stream from content streams. Refer to http://wiki.apache.org/solr/DataImportHandler for more
* details.
* This API is experimental and may change in the future.
*
* @since solr 3.1
diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/BinFileDataSource.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/BinFileDataSource.java
index 3ebf35ae8db..dc7a0f552e3 100644
--- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/BinFileDataSource.java
+++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/BinFileDataSource.java
@@ -28,13 +28,12 @@ import java.util.Properties;
*
* A DataSource which reads from local files
*
* Refer to http://wiki.apache.org/solr/DataImportHandler
* for more details.
*
* This API is experimental and may change in the future.
*
* @since solr 3.1
diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/BinURLDataSource.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/BinURLDataSource.java
index b7d7b73377e..3f9c5302b5c 100644
--- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/BinURLDataSource.java
+++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/BinURLDataSource.java
@@ -26,10 +26,10 @@ import java.net.URL;
import java.net.URLConnection;
import java.util.Properties;
/**
- * A data source implementation which can be used to read binary streams using HTTP. Refer to A data source implementation which can be used to read binary streams using HTTP. Refer to http://wiki.apache.org/solr/DataImportHandler for more
* details.
* This API is experimental and may change in the future.
*
* @since solr 3.1
diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/ClobTransformer.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/ClobTransformer.java
index ac0d3939585..4bbe0467349 100644
--- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/ClobTransformer.java
+++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/ClobTransformer.java
@@ -27,10 +27,10 @@ import java.util.Map;
/**
* {@link Transformer} instance which converts a {@link Clob} to a {@link String}.
- *
* Refer to http://wiki.apache.org/solr/DataImportHandler
* for more details.
- *
* This API is experimental and subject to change
*
* @since solr 1.4
diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/ContentStreamDataSource.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/ContentStreamDataSource.java
index 015b7f4e259..4482160c22b 100644
--- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/ContentStreamDataSource.java
+++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/ContentStreamDataSource.java
@@ -25,10 +25,10 @@ import java.util.Properties;
/**
* A DataSource implementation which reads from the ContentStream of a POST request
- *
* Refer to http://wiki.apache.org/solr/DataImportHandler
* for more details.
- *
* This API is experimental and may change in the future.
*
* @since solr 1.4
diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Context.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Context.java
index 325138fa7ae..56b821da7da 100644
--- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Context.java
+++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Context.java
@@ -32,7 +32,7 @@ import java.util.Map;
* href="http://wiki.apache.org/solr/DataImportHandler">http://wiki.apache.org/solr/DataImportHandler
* for more details.
*
* This API is experimental and subject to change
*
* @since solr 1.3
diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/DIHCache.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/DIHCache.java
index ae7ddb6d0a9..4b756d9c76b 100644
--- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/DIHCache.java
+++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/DIHCache.java
@@ -35,7 +35,6 @@ public interface DIHCache extends Iterable
* Refer to http://wiki.apache.org/solr/DataImportHandler
* for more details.
*
* This API is experimental and may change in the future.
*
* @since solr 1.3
diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/FileListEntityProcessor.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/FileListEntityProcessor.java
index d67d608627e..e86d09df5e1 100644
--- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/FileListEntityProcessor.java
+++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/FileListEntityProcessor.java
@@ -31,7 +31,6 @@ import org.apache.solr.util.DateMathParser;
* An {@link EntityProcessor} instance which can stream file names found in a given base
* directory matching patterns and returning rows containing file information.
*
* It supports querying a give base directory by matching:
*
@@ -43,14 +42,12 @@ import org.apache.solr.util.DateMathParser;
*
* Its output can be used along with {@link FileDataSource} to read from files in file
* systems.
- *
* Refer to http://wiki.apache.org/solr/DataImportHandler * for more details. *
- * + ** This API is experimental and may change in the future. * * @since solr 1.3 diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/JdbcDataSource.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/JdbcDataSource.java index 8c8de28ae90..cb836870573 100644 --- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/JdbcDataSource.java +++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/JdbcDataSource.java @@ -33,10 +33,10 @@ import java.util.concurrent.Callable; import java.util.concurrent.TimeUnit; /** - *
A DataSource implementation which can fetch data using JDBC.
Refer to A DataSource implementation which can fetch data using JDBC.
Refer to http://wiki.apache.org/solr/DataImportHandler for more * details.
- * + ** This API is experimental and may change in the future. * * @since solr 1.3 diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/LineEntityProcessor.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/LineEntityProcessor.java index 99bbea13e57..0940cbd4cf4 100644 --- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/LineEntityProcessor.java +++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/LineEntityProcessor.java @@ -28,7 +28,6 @@ import org.apache.commons.io.IOUtils; * An {@link EntityProcessor} instance which can stream lines of text read from a * datasource. Options allow lines to be explicitly skipped or included in the index. *
- * ** Attribute summary *
+ *
* Although envisioned for reading lines from a file or url, LineEntityProcessor may also be useful * for dealing with change lists, where each line contains filenames which can be used by subsequent entities * to parse content from those files. - *
** Refer to http://wiki.apache.org/solr/DataImportHandler * for more details. *
- * + ** This API is experimental and may change in the future. * * @since solr 1.4 diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/LogTransformer.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/LogTransformer.java index f0a1b979a1d..621ff7f6dc4 100644 --- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/LogTransformer.java +++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/LogTransformer.java @@ -23,10 +23,10 @@ import java.util.Map; /** * A {@link Transformer} implementation which logs messages in a given template format. - *
+ ** Refer to http://wiki.apache.org/solr/DataImportHandler * for more details. - *
+ ** This API is experimental and may change in the future. * * @since solr 1.4 diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/MockDataSource.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/MockDataSource.java index 5036a50c59e..8989ea2d07e 100644 --- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/MockDataSource.java +++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/MockDataSource.java @@ -25,7 +25,7 @@ import java.util.Properties; *
* A mock DataSource implementation which can be used for testing. *
- * + ** This API is experimental and may change in the future. * * @since solr 1.3 diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/NumberFormatTransformer.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/NumberFormatTransformer.java index 5c2875984a8..e2be66170b5 100644 --- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/NumberFormatTransformer.java +++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/NumberFormatTransformer.java @@ -33,13 +33,12 @@ import java.util.regex.Pattern; * Number, Integer, Currency and Percent styles as supported by * {@link NumberFormat} with configurable locales. *
- * ** Refer to http://wiki.apache.org/solr/DataImportHandler * for more details. *
- * + ** This API is experimental and may change in the future. * * @since solr 1.3 diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/RegexTransformer.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/RegexTransformer.java index c5ccaad7fd8..355aa4894ee 100644 --- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/RegexTransformer.java +++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/RegexTransformer.java @@ -27,13 +27,12 @@ import java.util.regex.Pattern; * A {@link Transformer} implementation which uses Regular Expressions to extract, split * and replace data in fields. *
- * ** Refer to http://wiki.apache.org/solr/DataImportHandler * for more details. *
- * + ** This API is experimental and may change in the future. * * @since solr 1.3 diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/ScriptTransformer.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/ScriptTransformer.java index 5dc058a6d1c..165d76d75f3 100644 --- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/ScriptTransformer.java +++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/ScriptTransformer.java @@ -31,13 +31,12 @@ import javax.script.ScriptException; * A {@link Transformer} instance capable of executing functions written in scripting * languages as a {@link Transformer} instance. *
- * ** Refer to http://wiki.apache.org/solr/DataImportHandler * for more details. *
- * + ** This API is experimental and may change in the future. * * @since solr 1.3 diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/SolrWriter.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/SolrWriter.java index 4a5dbb016c9..b536e2e9602 100644 --- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/SolrWriter.java +++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/SolrWriter.java @@ -32,7 +32,7 @@ import java.nio.charset.StandardCharsets; /** *
Writes documents to SOLR.
- * + ** This API is experimental and may change in the future. * * @since solr 1.3 diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/SqlEntityProcessor.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/SqlEntityProcessor.java index 864a137b9e6..076151a5720 100644 --- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/SqlEntityProcessor.java +++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/SqlEntityProcessor.java @@ -29,13 +29,12 @@ import java.util.regex.Pattern; * databases. It is used in conjunction with {@link JdbcDataSource}. This is the default * {@link EntityProcessor} if none is specified explicitly in data-config.xml *
- * ** Refer to http://wiki.apache.org/solr/DataImportHandler * for more details. *
- * + ** This API is experimental and may change in the future. * * diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/TemplateTransformer.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/TemplateTransformer.java index 7d83ea3b5cf..99da9efe629 100644 --- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/TemplateTransformer.java +++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/TemplateTransformer.java @@ -27,20 +27,18 @@ import org.slf4j.LoggerFactory; * A {@link Transformer} which can put values into a column by resolving an expression * containing other columns *
- * *
- * For example:
+ * For example:
* <field column="name" template="${e.lastName}, ${e.firstName}
* ${e.middleName}" /> will produce the name by combining values from
* lastName, firstName and middleName fields as given in the template attribute.
*
* Refer to http://wiki.apache.org/solr/DataImportHandler * for more details. *
- * + ** This API is experimental and may change in the future. * * diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Transformer.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Transformer.java index 4bbde75b796..c7923e1a7dc 100644 --- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Transformer.java +++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Transformer.java @@ -22,17 +22,15 @@ import java.util.Map; *
* Use this API to implement a custom transformer for any given entity *
- * ** Implementations of this abstract class must provide a public no-args constructor. *
- * ** Refer to http://wiki.apache.org/solr/DataImportHandler * for more details. *
- * + ** This API is experimental and may change in the future. * * diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/URLDataSource.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/URLDataSource.java index b7609ade6ea..d5ed8a09396 100644 --- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/URLDataSource.java +++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/URLDataSource.java @@ -30,10 +30,10 @@ import java.util.regex.Matcher; import java.util.regex.Pattern; /** - *
A data source implementation which can be used to read character files using HTTP.
Refer to A data source implementation which can be used to read character files using HTTP.
Refer to http://wiki.apache.org/solr/DataImportHandler for more * details.
- * + ** This API is experimental and may change in the future. * * diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathEntityProcessor.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathEntityProcessor.java index acc4487ce36..92fa72224c0 100644 --- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathEntityProcessor.java +++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathEntityProcessor.java @@ -43,10 +43,10 @@ import java.util.concurrent.atomic.AtomicReference; /** *
An implementation of {@link EntityProcessor} which uses a streaming xpath parser to extract values out of XML documents. - * It is typically used in conjunction with {@link URLDataSource} or {@link FileDataSource}.
Refer to Refer to http://wiki.apache.org/solr/DataImportHandler for more
* details.
* This API is experimental and may change in the future.
*
*
diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathRecordReader.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathRecordReader.java
index 68cb859ad31..0a5639ec00a 100644
--- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathRecordReader.java
+++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathRecordReader.java
@@ -50,10 +50,8 @@ import org.slf4j.LoggerFactory;
* This class is thread-safe for parsing xml. But adding fields is not
* thread-safe. The recommended usage is to addField() in one thread and
* then share the instance across threads.
- *
+ * This API is experimental and may change in the future.
*
* @since solr 1.3
*/
diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/config/DIHConfiguration.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/config/DIHConfiguration.java
index ee668bca43d..dc89b0fe29f 100644
--- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/config/DIHConfiguration.java
+++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/config/DIHConfiguration.java
@@ -36,13 +36,12 @@ import org.w3c.dom.Element;
*
* Mapping for data-config.xml
*
* Refer to http://wiki.apache.org/solr/DataImportHandler
* for more details.
*
* This API is experimental and subject to change
*
* @since solr 1.3
diff --git a/solr/contrib/dataimporthandler/src/test/org/apache/solr/handler/dataimport/AbstractDataImportHandlerTestCase.java b/solr/contrib/dataimporthandler/src/test/org/apache/solr/handler/dataimport/AbstractDataImportHandlerTestCase.java
index 12bed334a65..23734751006 100644
--- a/solr/contrib/dataimporthandler/src/test/org/apache/solr/handler/dataimport/AbstractDataImportHandlerTestCase.java
+++ b/solr/contrib/dataimporthandler/src/test/org/apache/solr/handler/dataimport/AbstractDataImportHandlerTestCase.java
@@ -44,7 +44,7 @@ import org.junit.Before;
*
* Abstract base class for DataImportHandler tests
*
* This API is experimental and subject to change
*
*
diff --git a/solr/contrib/dataimporthandler/src/test/org/apache/solr/handler/dataimport/TestJdbcDataSource.java b/solr/contrib/dataimporthandler/src/test/org/apache/solr/handler/dataimport/TestJdbcDataSource.java
index 2725b776360..8e2d5dd1658 100644
--- a/solr/contrib/dataimporthandler/src/test/org/apache/solr/handler/dataimport/TestJdbcDataSource.java
+++ b/solr/contrib/dataimporthandler/src/test/org/apache/solr/handler/dataimport/TestJdbcDataSource.java
@@ -35,7 +35,6 @@ import org.junit.Test;
*
* Test for JdbcDataSource
*
* Note: The tests are ignored for the lack of DB support for testing
*
* Test for ScriptTransformer
- *
* To map a field, add a name like:
*
* For example
*
* See Tika's docs for what the extracted document looks like.
- *
* The Capture field is based on the localName returned to the {@link SolrContentHandler}
* by Tika, not to be confused by the mapped field. The field name can then
* be mapped into the index schema.
- *
* For instance, a Tika document may look like:
*
* User's may wish to override this class to provide their own functionality.
*
* @see org.apache.solr.handler.extraction.SolrContentHandlerFactory
@@ -313,7 +312,7 @@ public class SolrContentHandler extends DefaultHandler implements ExtractingPara
/**
* Can be used to transform input values based on their {@link org.apache.solr.schema.SchemaField}
- *
* This implementation only formats dates using the {@link org.apache.solr.common.util.DateUtil}.
*
* @param val The value to transform
diff --git a/solr/contrib/extraction/src/java/org/apache/solr/handler/extraction/SolrContentHandlerFactory.java b/solr/contrib/extraction/src/java/org/apache/solr/handler/extraction/SolrContentHandlerFactory.java
index acf94a2d801..c91dd47306f 100644
--- a/solr/contrib/extraction/src/java/org/apache/solr/handler/extraction/SolrContentHandlerFactory.java
+++ b/solr/contrib/extraction/src/java/org/apache/solr/handler/extraction/SolrContentHandlerFactory.java
@@ -1,4 +1,4 @@
-/**
+/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
diff --git a/solr/contrib/langid/src/java/org/apache/solr/update/processor/LangDetectLanguageIdentifierUpdateProcessorFactory.java b/solr/contrib/langid/src/java/org/apache/solr/update/processor/LangDetectLanguageIdentifierUpdateProcessorFactory.java
index 3b83ea79306..633d1a7290c 100644
--- a/solr/contrib/langid/src/java/org/apache/solr/update/processor/LangDetectLanguageIdentifierUpdateProcessorFactory.java
+++ b/solr/contrib/langid/src/java/org/apache/solr/update/processor/LangDetectLanguageIdentifierUpdateProcessorFactory.java
@@ -41,7 +41,7 @@ import com.cybozu.labs.langdetect.LangDetectException;
/**
* Identifies the language of a set of input fields using
* http://code.google.com/p/language-detection
- *
* The UpdateProcessorChain config entry can take a number of parameters
* which may also be passed as HTTP parameters on the update request
* and override the defaults. Here is the simplest processor config possible:
diff --git a/solr/contrib/langid/src/java/org/apache/solr/update/processor/TikaLanguageIdentifierUpdateProcessorFactory.java b/solr/contrib/langid/src/java/org/apache/solr/update/processor/TikaLanguageIdentifierUpdateProcessorFactory.java
index e19270b9012..7a6c81ea3f2 100644
--- a/solr/contrib/langid/src/java/org/apache/solr/update/processor/TikaLanguageIdentifierUpdateProcessorFactory.java
+++ b/solr/contrib/langid/src/java/org/apache/solr/update/processor/TikaLanguageIdentifierUpdateProcessorFactory.java
@@ -28,7 +28,7 @@ import org.apache.solr.util.plugin.SolrCoreAware;
/**
* Identifies the language of a set of input fields using Tika's
* LanguageIdentifier. The tika-core-x.y.jar must be on the classpath
- *
* The UpdateProcessorChain config entry can take a number of parameters
* which may also be passed as HTTP parameters on the update request
* and override the defaults. Here is the simplest processor config possible:
diff --git a/solr/core/src/java/org/apache/solr/client/solrj/embedded/JettySolrRunner.java b/solr/core/src/java/org/apache/solr/client/solrj/embedded/JettySolrRunner.java
index 5e6b34e4470..b14f944fb16 100644
--- a/solr/core/src/java/org/apache/solr/client/solrj/embedded/JettySolrRunner.java
+++ b/solr/core/src/java/org/apache/solr/client/solrj/embedded/JettySolrRunner.java
@@ -172,7 +172,7 @@ public class JettySolrRunner {
}
/**
- * Constructor taking an ordered list of additional (servlet holder -> path spec) mappings
+ * Constructor taking an ordered list of additional (servlet holder -> path spec) mappings
* to add to the servlet context
*/
public JettySolrRunner(String solrHome, String context, int port,
@@ -190,7 +190,7 @@ public class JettySolrRunner {
}
/**
- * Constructor taking an ordered list of additional (filter holder -> path spec) mappings.
+ * Constructor taking an ordered list of additional (filter holder -> path spec) mappings.
* Filters are placed after the DebugFilter but before the SolrDispatchFilter.
*/
public JettySolrRunner(String solrHome, String context, int port,
diff --git a/solr/core/src/java/org/apache/solr/cloud/CloudUtil.java b/solr/core/src/java/org/apache/solr/cloud/CloudUtil.java
index 14c7f96f3ae..333fd50b7b3 100644
--- a/solr/core/src/java/org/apache/solr/cloud/CloudUtil.java
+++ b/solr/core/src/java/org/apache/solr/cloud/CloudUtil.java
@@ -89,7 +89,7 @@ public class CloudUtil {
/**
* Returns a displayable unified path to the given resource. For non-solrCloud that will be the
* same as getConfigDir, but for Cloud it will be getConfigSetZkPath ending in a /
- *
* Note: Do not use this to generate a valid file path, but for debug printing etc
* @param loader Resource loader instance
* @return a String of path to resource
diff --git a/solr/core/src/java/org/apache/solr/cloud/ZkSolrResourceLoader.java b/solr/core/src/java/org/apache/solr/cloud/ZkSolrResourceLoader.java
index 3d9ec26dbd8..1fe93539407 100644
--- a/solr/core/src/java/org/apache/solr/cloud/ZkSolrResourceLoader.java
+++ b/solr/core/src/java/org/apache/solr/cloud/ZkSolrResourceLoader.java
@@ -56,7 +56,6 @@ public class ZkSolrResourceLoader extends SolrResourceLoader {
* will delegate to the context classloader when possible,
* otherwise it will attempt to resolve resources using any jar files found in
* the "lib/" directory in the specified instance directory.
- *
*/
public ZkSolrResourceLoader(String instanceDir, String configSet, ClassLoader parent,
Properties coreProperties, ZkController zooKeeperController) {
diff --git a/solr/core/src/java/org/apache/solr/core/AbstractSolrEventListener.java b/solr/core/src/java/org/apache/solr/core/AbstractSolrEventListener.java
index 839c3dc7f9f..8a7101d01a0 100644
--- a/solr/core/src/java/org/apache/solr/core/AbstractSolrEventListener.java
+++ b/solr/core/src/java/org/apache/solr/core/AbstractSolrEventListener.java
@@ -61,7 +61,7 @@ public class AbstractSolrEventListener implements SolrEventListener {
/**
* Add the {@link org.apache.solr.common.params.EventParams#EVENT} with either the {@link org.apache.solr.common.params.EventParams#NEW_SEARCHER}
* or {@link org.apache.solr.common.params.EventParams#FIRST_SEARCHER} values depending on the value of currentSearcher.
- *
* Makes a copy of NamedList and then adds the parameters.
*
*
diff --git a/solr/core/src/java/org/apache/solr/core/CloseHook.java b/solr/core/src/java/org/apache/solr/core/CloseHook.java
index 032f44ced0b..d59c179c6bc 100644
--- a/solr/core/src/java/org/apache/solr/core/CloseHook.java
+++ b/solr/core/src/java/org/apache/solr/core/CloseHook.java
@@ -19,10 +19,10 @@ package org.apache.solr.core;
/**
* Used to request notification when the core is closed.
- *
* Call {@link org.apache.solr.core.SolrCore#addCloseHook(org.apache.solr.core.CloseHook)} during the {@link org.apache.solr.util.plugin.SolrCoreAware#inform(SolrCore)} method to
* add a close hook to your object.
- *
* The close hook can be useful for releasing objects related to the request handler (for instance, if you have a JDBC DataSource or something like that)
*/
@@ -31,7 +31,7 @@ public abstract class CloseHook {
/**
* Method called when the given SolrCore object is closing / shutting down but before the update handler and
* searcher(s) are actually closed
- *
- * Consider passing a non-null 'name' parameter in all use-cases since it is used for logging & exception reporting.
+ * Consider passing a non-null 'name' parameter in all use-cases since it is used for logging & exception reporting.
*
* Provides features for looking up IndexCommit given a version. Allows reserving index
* commit points for certain amounts of time to support features such as index replication
* or snapshooting directly out of a live index directory.
- *
* NOTE: The {@link #clone()} method returns this in order to make
* this {@link IndexDeletionPolicy} instance trackable across {@link IndexWriter}
* instantiations. This is correct because each core has its own
@@ -59,7 +59,7 @@ public final class IndexDeletionPolicyWrapper extends IndexDeletionPolicy {
/**
* Gets the most recent commit point
- *
* It is recommended to reserve a commit point for the duration of usage so that
* it is not deleted by the underlying deletion policy
*
diff --git a/solr/core/src/java/org/apache/solr/core/JmxMonitoredMap.java b/solr/core/src/java/org/apache/solr/core/JmxMonitoredMap.java
index 840cb0d8466..e10bf3be6eb 100644
--- a/solr/core/src/java/org/apache/solr/core/JmxMonitoredMap.java
+++ b/solr/core/src/java/org/apache/solr/core/JmxMonitoredMap.java
@@ -40,7 +40,6 @@ import java.util.concurrent.ConcurrentHashMap;
* Responsible for finding (or creating) a MBeanServer from given configuration
* and registering all SolrInfoMBean objects with JMX.
*
* Please see http://wiki.apache.org/solr/SolrJmx for instructions on usage and configuration
*
+ *
*
* The behavior of this method is determined by the result of decrementing
* the core's reference count (A core is created with a reference count of 1)...
*
* Implementations should add the {@link org.apache.solr.common.params.EventParams#EVENT} parameter and set it to a value of either:
*
*/
public SolrResourceLoader( String instanceDir, ClassLoader parent )
{
@@ -286,7 +285,7 @@ public class SolrResourceLoader implements ResourceLoader,Closeable
/**
* EXPERT
- *
* The underlying class loader. Most applications will not need to use this.
* @return The {@link ClassLoader}
*/
diff --git a/solr/core/src/java/org/apache/solr/handler/DocumentAnalysisRequestHandler.java b/solr/core/src/java/org/apache/solr/handler/DocumentAnalysisRequestHandler.java
index a1e7dac45f6..f4ac13bb492 100644
--- a/solr/core/src/java/org/apache/solr/handler/DocumentAnalysisRequestHandler.java
+++ b/solr/core/src/java/org/apache/solr/handler/DocumentAnalysisRequestHandler.java
@@ -50,7 +50,7 @@ import java.util.*;
/**
* An analysis handler that provides a breakdown of the analysis process of provided documents. This handler expects a
* (single) content stream of the following format:
- *
* Like the {@link org.apache.solr.handler.FieldAnalysisRequestHandler}, this handler also supports query analysis by
* sending either an "analysis.query" or "q" request parameter that holds the query text to be analyzed. It also
* supports the "analysis.showmatch" parameter which when set to {@code true}, all field tokens that match the query
diff --git a/solr/core/src/java/org/apache/solr/handler/FieldAnalysisRequestHandler.java b/solr/core/src/java/org/apache/solr/handler/FieldAnalysisRequestHandler.java
index 7fde9ccb1b4..15b79e7347b 100644
--- a/solr/core/src/java/org/apache/solr/handler/FieldAnalysisRequestHandler.java
+++ b/solr/core/src/java/org/apache/solr/handler/FieldAnalysisRequestHandler.java
@@ -38,7 +38,7 @@ import java.util.Set;
/**
* Provides the ability to specify multiple field types and field names in the same request. Expected parameters:
- * A Handler which provides a REST API for replication and serves replication requests from Slaves. A Handler which provides a REST API for replication and serves replication requests from Slaves. When running on the master, it provides the following commands When running on the slave, it provides the following
+ * When running on the slave, it provides the following
* commands Provides functionality of downloading changed index files as well as config files and a timer for scheduling fetches from the
* master. Provides functionality equivalent to the snapshooter script
* This method could be overridden by derived classes to handle custom actions.
+ *
* The ExpandComponent expands the collapsed groups for a single page.
- *
* http parameters:
- *
+ * expand=true
* 9/10/2009 - Moved out of StatsComponent to allow open access to UnInvertedField
- *
* Info available:
* term, frequency, position, offset, IDF.
- *
* Note Returning IDF can be expensive.
*
*
* Given a set of intervals for a field and a DocSet, it calculates the number
* of documents that match each of the intervals provided. The final count for
* each interval should be exactly the same as the number of results of a range
@@ -61,12 +61,12 @@ import org.apache.solr.search.SyntaxError;
* of {@code facet.query=field:[A TO B]} should be the same as the count of
* {@code f.field.facet.interval.set=[A,B]}, however, this method will usually
* be faster in cases where there are a larger number of intervals per field.
- *
* To use this class, create an instance using
* {@link #IntervalFacets(SchemaField, SolrIndexSearcher, DocSet, String[], SolrParams)}
* and then iterate the {@link FacetInterval} using {@link #iterator()}
- *
+ * Intervals Format
*
* To use this class:
*
* This method is mainly used by the {@link org.apache.solr.handler.component.StatsComponent}.
*
* @param searcher The Searcher to use to gather the statistics
diff --git a/solr/core/src/java/org/apache/solr/response/SolrQueryResponse.java b/solr/core/src/java/org/apache/solr/response/SolrQueryResponse.java
index 17525a3c2c2..9ae7813d796 100644
--- a/solr/core/src/java/org/apache/solr/response/SolrQueryResponse.java
+++ b/solr/core/src/java/org/apache/solr/response/SolrQueryResponse.java
@@ -35,7 +35,7 @@ import org.apache.solr.search.SolrReturnFields;
* the response to a query request.
*
*
- * Note On Returnable Data...
* New instance for each request
*
* @see TransformerFactory
diff --git a/solr/core/src/java/org/apache/solr/rest/BaseSolrResource.java b/solr/core/src/java/org/apache/solr/rest/BaseSolrResource.java
index 99ce8be744d..ae83d886275 100644
--- a/solr/core/src/java/org/apache/solr/rest/BaseSolrResource.java
+++ b/solr/core/src/java/org/apache/solr/rest/BaseSolrResource.java
@@ -73,7 +73,7 @@ public abstract class BaseSolrResource extends ServerResource {
* from the SolrRequestInfo thread local, then gets the SolrCore
* and IndexSchema and sets up the response.
* writer.
- *
* If an error occurs during initialization, setExisting(false) is
* called and an error status code and message is set; in this case,
* Restlet will not continue servicing the request (by calling the
diff --git a/solr/core/src/java/org/apache/solr/rest/schema/BaseFieldResource.java b/solr/core/src/java/org/apache/solr/rest/schema/BaseFieldResource.java
index 707e97b262a..51f10866258 100644
--- a/solr/core/src/java/org/apache/solr/rest/schema/BaseFieldResource.java
+++ b/solr/core/src/java/org/apache/solr/rest/schema/BaseFieldResource.java
@@ -56,7 +56,7 @@ abstract class BaseFieldResource extends BaseSolrResource {
* on this list. The (Dynamic)FieldResource classes ignore this list,
* since the (dynamic) field is specified in the URL path, rather than
* in a query parameter.
- *
* Also pulls the "showDefaults" param from the request, for use by all
* subclasses to include default values from the associated field type
* in the response. By default this param is off.
diff --git a/solr/core/src/java/org/apache/solr/rest/schema/CopyFieldCollectionResource.java b/solr/core/src/java/org/apache/solr/rest/schema/CopyFieldCollectionResource.java
index 365217a9e0a..ba59f536e76 100644
--- a/solr/core/src/java/org/apache/solr/rest/schema/CopyFieldCollectionResource.java
+++ b/solr/core/src/java/org/apache/solr/rest/schema/CopyFieldCollectionResource.java
@@ -43,7 +43,7 @@ import static org.apache.solr.common.SolrException.ErrorCode;
/**
* This class responds to requests at /solr/(corename)/schema/copyfields
- *
*
* To restrict the set of copyFields in the response, specify one or both
* of the following as query parameters, with values as space and/or comma
diff --git a/solr/core/src/java/org/apache/solr/rest/schema/DynamicFieldCollectionResource.java b/solr/core/src/java/org/apache/solr/rest/schema/DynamicFieldCollectionResource.java
index 854717d4bd8..314b3331bba 100644
--- a/solr/core/src/java/org/apache/solr/rest/schema/DynamicFieldCollectionResource.java
+++ b/solr/core/src/java/org/apache/solr/rest/schema/DynamicFieldCollectionResource.java
@@ -41,7 +41,7 @@ import java.util.Map;
/**
* This class responds to requests at /solr/(corename)/schema/dynamicfields
- *
* To restrict the set of dynamic fields in the response, specify a comma
* and/or space separated list of dynamic field patterns in the "fl" query
* parameter.
diff --git a/solr/core/src/java/org/apache/solr/rest/schema/FieldCollectionResource.java b/solr/core/src/java/org/apache/solr/rest/schema/FieldCollectionResource.java
index b1314462e0c..78357c9ff5e 100644
--- a/solr/core/src/java/org/apache/solr/rest/schema/FieldCollectionResource.java
+++ b/solr/core/src/java/org/apache/solr/rest/schema/FieldCollectionResource.java
@@ -48,7 +48,7 @@ import java.util.TreeSet;
/**
* This class responds to requests at /solr/(corename)/schema/fields
- *
* Two query parameters are supported:
*
* The GET method returns properties for the given fieldname.
* The "includeDynamic" query parameter, if specified, will cause the
* dynamic field matching the given fieldname to be returned if fieldname
* is not explicitly declared in the schema.
- *
* The PUT method accepts field addition requests in JSON format.
*/
public class FieldResource extends BaseFieldResource implements GETable, PUTable {
diff --git a/solr/core/src/java/org/apache/solr/schema/AbstractSpatialFieldType.java b/solr/core/src/java/org/apache/solr/schema/AbstractSpatialFieldType.java
index f55158759e5..89357eb9adb 100644
--- a/solr/core/src/java/org/apache/solr/schema/AbstractSpatialFieldType.java
+++ b/solr/core/src/java/org/apache/solr/schema/AbstractSpatialFieldType.java
@@ -242,7 +242,7 @@ public abstract class AbstractSpatialFieldType
* Spatial4j 0.4 is probably the last release to support SpatialContext.toString(shape) but it's deprecated with no
* planned replacement. Shapes do have a toString() method but they are generally internal/diagnostic and not
* standard WKT.
@@ -268,7 +268,7 @@ public abstract class AbstractSpatialFieldType Solr looks for the external file in the index directory under the name of
* external_<fieldname> or external_<fieldname>.*
*
- * If any files of the latter pattern appear, the last (after being sorted by name) will be used and previous versions will be deleted.
* This is to help support systems where one may not be able to overwrite a file (like Windows, if the file is in use).
- * If the external file has already been loaded, and it is changed, those changes will not be visible until a commit has been done.
+ * The external file may be sorted or unsorted by the key field, but it will be substantially slower (untested) if it isn't sorted.
+ * Fields of this type may currently only be used as a ValueSource in a FunctionQuery.
*
* @see ExternalFileFieldReloader
*/
diff --git a/solr/core/src/java/org/apache/solr/schema/ExternalFileFieldReloader.java b/solr/core/src/java/org/apache/solr/schema/ExternalFileFieldReloader.java
index a2d6d4e31b3..1d29e478ef9 100644
--- a/solr/core/src/java/org/apache/solr/schema/ExternalFileFieldReloader.java
+++ b/solr/core/src/java/org/apache/solr/schema/ExternalFileFieldReloader.java
@@ -41,8 +41,8 @@ import java.util.List;
* listeners in your solrconfig.xml:
*
*
@@ -434,7 +434,7 @@ public abstract class FieldType extends FieldProperties {
/**
* Returns a Query instance for doing prefix searches on this field type.
* Also, other QueryParser implementations may have different semantics.
- *
* Sub-classes should override this method to provide their own range query implementation.
*
* @param parser the {@link org.apache.solr.search.QParser} calling the method
@@ -676,7 +676,7 @@ public abstract class FieldType extends FieldProperties {
* currently passes part1 and part2 as null if they are '*' respectively. minInclusive and maxInclusive are both true
* currently by SolrQueryParser but that may change in the future. Also, other QueryParser implementations may have
* different semantics.
- *
* Sub-classes should override this method to provide their own range query implementation. They should strive to
* handle nulls in part1 and/or part2 as well as unequal minInclusive and maxInclusive parameters gracefully.
*
@@ -792,7 +792,7 @@ public abstract class FieldType extends FieldProperties {
private static final String POSITION_INCREMENT_GAP = "positionIncrementGap";
/**
- * Get a map of property name -> value for this field type.
+ * Get a map of property name -> value for this field type.
* @param showDefaults if true, include default properties.
*/
public SimpleOrderedMap
* Internally this update processor uses JDK 6 scripting engine support,
* and any {@link Invocable} implementations of
+ *
+ *
* @see UUID
*/
public class UUIDUpdateProcessorFactory extends UpdateRequestProcessorFactory {
diff --git a/solr/core/src/java/org/apache/solr/util/ConcurrentLFUCache.java b/solr/core/src/java/org/apache/solr/util/ConcurrentLFUCache.java
index f0b031f9d3e..8f14ce9c372 100644
--- a/solr/core/src/java/org/apache/solr/util/ConcurrentLFUCache.java
+++ b/solr/core/src/java/org/apache/solr/util/ConcurrentLFUCache.java
@@ -31,11 +31,11 @@ import java.util.concurrent.locks.ReentrantLock;
/**
* A LFU cache implementation based upon ConcurrentHashMap.
- *
* This is not a terribly efficient implementation. The tricks used in the
* LRU version were not directly usable, perhaps it might be possible to
* rewrite them with LFU in mind.
- *
* This API is experimental and subject to change
*
* @since solr 1.6
@@ -215,7 +215,7 @@ public class ConcurrentLFUCache
* This uses a TreeSet to collect the 'n' least used items ordered by ascending hitcount
* and returns a LinkedHashMap containing 'n' or less than 'n' entries.
*
@@ -259,7 +259,7 @@ public class ConcurrentLFUCache
* This uses a TreeSet to collect the 'n' most used items ordered by descending hitcount
* and returns a LinkedHashMap containing 'n' or less than 'n' entries.
*
diff --git a/solr/core/src/java/org/apache/solr/util/ConcurrentLRUCache.java b/solr/core/src/java/org/apache/solr/util/ConcurrentLRUCache.java
index be7068a6207..9a774f2c58c 100644
--- a/solr/core/src/java/org/apache/solr/util/ConcurrentLRUCache.java
+++ b/solr/core/src/java/org/apache/solr/util/ConcurrentLRUCache.java
@@ -34,7 +34,7 @@ import java.lang.ref.WeakReference;
/**
* A LRU cache implementation based upon ConcurrentHashMap and other techniques to reduce
* contention and synchronization overhead to utilize multiple CPU cores more effectively.
- *
* Note that the implementation does not follow a true LRU (least-recently-used) eviction
* strategy. Instead it strives to remove least recently used items but when the initial
* cleanup does not remove enough items to reach the 'acceptableWaterMark' limit, it can
diff --git a/solr/core/src/java/org/apache/solr/util/LongPriorityQueue.java b/solr/core/src/java/org/apache/solr/util/LongPriorityQueue.java
index 2b0dcf74c2a..e02a01c4a99 100644
--- a/solr/core/src/java/org/apache/solr/util/LongPriorityQueue.java
+++ b/solr/core/src/java/org/apache/solr/util/LongPriorityQueue.java
@@ -149,7 +149,7 @@ public class LongPriorityQueue {
}
/** Removes and returns the least element of the PriorityQueue in log(size)
- time. Only valid if size() > 0.
+ time. Only valid if size() > 0.
*/
public long pop() {
long result = heap[1]; // save first value
diff --git a/solr/core/src/java/org/apache/solr/util/SimplePostTool.java b/solr/core/src/java/org/apache/solr/util/SimplePostTool.java
index d9879eac3af..84ce8b2c543 100644
--- a/solr/core/src/java/org/apache/solr/util/SimplePostTool.java
+++ b/solr/core/src/java/org/apache/solr/util/SimplePostTool.java
@@ -564,7 +564,7 @@ public class SimplePostTool {
/**
* A very simple crawler, pulling URLs to fetch from a backlog and then
- * recurses N levels deep if recursive>0. Links are parsed from HTML
+ * recurses N levels deep if recursive>0. Links are parsed from HTML
* through first getting an XHTML version using SolrCell with extractOnly,
* and followed if they are local. The crawler pauses for a default delay
* of 10 seconds between each fetch, this can be configured in the delay
@@ -744,7 +744,7 @@ public class SimplePostTool {
/**
* Appends a URL query parameter to a URL
* @param url the original URL
- * @param param the parameter(s) to append, separated by "&"
+ * @param param the parameter(s) to append, separated by "&"
* @return the string version of the resulting URL
*/
public static String appendParam(String url, String param) {
diff --git a/solr/core/src/test/org/apache/solr/BasicFunctionalityTest.java b/solr/core/src/test/org/apache/solr/BasicFunctionalityTest.java
index 7cf28dd629a..e57a8bdaaf2 100644
--- a/solr/core/src/test/org/apache/solr/BasicFunctionalityTest.java
+++ b/solr/core/src/test/org/apache/solr/BasicFunctionalityTest.java
@@ -77,7 +77,7 @@ public class BasicFunctionalityTest extends SolrTestCaseJ4 {
}
// tests the performance of dynamic field creation and
// field property testing.
- /***
+ /*
public void testFieldPerf() {
IndexSchema schema = h.getCore().getSchema();
SchemaField[] fields = schema.getDynamicFieldPrototypes();
diff --git a/solr/core/src/test/org/apache/solr/CursorPagingTest.java b/solr/core/src/test/org/apache/solr/CursorPagingTest.java
index 3b7c8a2c08d..9154f3633c0 100644
--- a/solr/core/src/test/org/apache/solr/CursorPagingTest.java
+++ b/solr/core/src/test/org/apache/solr/CursorPagingTest.java
@@ -22,17 +22,19 @@ import org.apache.lucene.util.SentinelIntSet;
import org.apache.lucene.util.mutable.MutableValueInt;
import org.apache.solr.core.SolrInfoMBean;
import org.apache.solr.common.SolrInputDocument;
+import org.apache.solr.common.params.CursorMarkParams;
import org.apache.solr.common.params.SolrParams;
import org.apache.solr.common.params.CommonParams;
import org.apache.solr.common.params.GroupParams;
+
import static org.apache.solr.common.params.CursorMarkParams.CURSOR_MARK_PARAM;
import static org.apache.solr.common.params.CursorMarkParams.CURSOR_MARK_NEXT;
import static org.apache.solr.common.params.CursorMarkParams.CURSOR_MARK_START;
+
import org.apache.solr.common.SolrException;
import org.apache.solr.common.SolrException.ErrorCode;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.search.CursorMark; //jdoc
-
import org.noggit.ObjectBuilder;
import java.nio.ByteBuffer;
@@ -49,7 +51,7 @@ import org.junit.BeforeClass;
import org.junit.After;
/**
- * Tests of deep paging using {@link CursorMark} and {@link #CURSOR_MARK_PARAM}.
+ * Tests of deep paging using {@link CursorMark} and {@link CursorMarkParams#CURSOR_MARK_PARAM}.
*/
public class CursorPagingTest extends SolrTestCaseJ4 {
@@ -651,8 +653,8 @@ public class CursorPagingTest extends SolrTestCaseJ4 {
}
/**
- * Given a set of params, executes a cursor query using {@link #CURSOR_MARK_START}
- * and then continuously walks the results using {@link #CURSOR_MARK_START} as long
+ * Given a set of params, executes a cursor query using {@link CursorMarkParams#CURSOR_MARK_START}
+ * and then continuously walks the results using {@link CursorMarkParams#CURSOR_MARK_START} as long
* as a non-0 number of docs ar returned. This method records the the set of all id's
* (must be positive ints) encountered and throws an assertion failure if any id is
* encountered more than once, or if the set grows above maxSize
@@ -733,8 +735,8 @@ public class CursorPagingTest extends SolrTestCaseJ4 {
}
/**
- * Given a set of params, executes a cursor query using {@link #CURSOR_MARK_START}
- * and then continuously walks the results using {@link #CURSOR_MARK_START} as long
+ * Given a set of params, executes a cursor query using {@link CursorMarkParams#CURSOR_MARK_START}
+ * and then continuously walks the results using {@link CursorMarkParams#CURSOR_MARK_START} as long
* as a non-0 number of docs ar returned. This method records the the set of all id's
* (must be positive ints) encountered and throws an assertion failure if any id is
* encountered more than once, or if the set grows above maxSize.
@@ -817,7 +819,7 @@ public class CursorPagingTest extends SolrTestCaseJ4 {
/**
* Asserts that the query matches the specified JSON patterns and then returns the
- * {@link #CURSOR_MARK_NEXT} value from the response
+ * {@link CursorMarkParams#CURSOR_MARK_NEXT} value from the response
*
* @see #assertJQ
*/
diff --git a/solr/core/src/test/org/apache/solr/analysis/TestCharFilters.java b/solr/core/src/test/org/apache/solr/analysis/TestCharFilters.java
index 317509cc1be..1e15c179281 100644
--- a/solr/core/src/test/org/apache/solr/analysis/TestCharFilters.java
+++ b/solr/core/src/test/org/apache/solr/analysis/TestCharFilters.java
@@ -39,7 +39,7 @@ public class TestCharFilters extends SolrTestCaseJ4 {
/**
* Test query analysis: at querytime MockCharFilter will
- * double the 'a', so ab -> aab, and aba -> aabaa
+ * double the 'a', so ab -> aab, and aba -> aabaa
*
* We run the test twice to make sure reuse is working
*/
@@ -58,7 +58,7 @@ public class TestCharFilters extends SolrTestCaseJ4 {
/**
* Test index analysis: at indextime MockCharFilter will
- * double the 'a', so ab -> aab, and aba -> aabaa
+ * double the 'a', so ab -> aab, and aba -> aabaa
*
* We run the test twice to make sure reuse is working
*/
diff --git a/solr/core/src/test/org/apache/solr/analysis/TestWordDelimiterFilterFactory.java b/solr/core/src/test/org/apache/solr/analysis/TestWordDelimiterFilterFactory.java
index 40cf1df52a0..1464364fc78 100644
--- a/solr/core/src/test/org/apache/solr/analysis/TestWordDelimiterFilterFactory.java
+++ b/solr/core/src/test/org/apache/solr/analysis/TestWordDelimiterFilterFactory.java
@@ -126,7 +126,7 @@ public class TestWordDelimiterFilterFactory extends SolrTestCaseJ4 {
clearIndex();
}
- /***
+ /*
public void testPerformance() throws IOException {
String s = "now is the time-for all good men to come to-the aid of their country.";
Token tok = new Token();
diff --git a/solr/core/src/test/org/apache/solr/cloud/DistribCursorPagingTest.java b/solr/core/src/test/org/apache/solr/cloud/DistribCursorPagingTest.java
index 6a7debc2210..af5aabf5890 100644
--- a/solr/core/src/test/org/apache/solr/cloud/DistribCursorPagingTest.java
+++ b/solr/core/src/test/org/apache/solr/cloud/DistribCursorPagingTest.java
@@ -17,6 +17,7 @@
package org.apache.solr.cloud;
import com.carrotsearch.randomizedtesting.annotations.Seed;
+
import org.apache.lucene.util.LuceneTestCase.Slow;
import org.apache.lucene.util.SentinelIntSet;
import org.apache.lucene.util.TestUtil;
@@ -30,15 +31,17 @@ import org.apache.solr.common.SolrException;
import org.apache.solr.common.SolrException.ErrorCode;
import org.apache.solr.common.SolrInputDocument;
import org.apache.solr.common.params.CommonParams;
+import org.apache.solr.common.params.CursorMarkParams;
import org.apache.solr.common.params.GroupParams;
import org.apache.solr.common.params.SolrParams;
import org.apache.solr.common.util.NamedList;
import org.apache.solr.search.CursorMark;
+
import static org.apache.solr.common.params.CursorMarkParams.CURSOR_MARK_PARAM;
import static org.apache.solr.common.params.CursorMarkParams.CURSOR_MARK_NEXT;
import static org.apache.solr.common.params.CursorMarkParams.CURSOR_MARK_START;
-import org.apache.solr.search.CursorMark; //jdoc
+import org.apache.solr.search.CursorMark; //jdoc
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -50,7 +53,7 @@ import java.util.List;
import java.util.Map;
/**
- * Distributed tests of deep paging using {@link CursorMark} and {@link #CURSOR_MARK_PARAM}.
+ * Distributed tests of deep paging using {@link CursorMark} and {@link CursorMarkParams#CURSOR_MARK_PARAM}.
*
* NOTE: this class Reuses some utilities from {@link CursorPagingTest} that assume the same schema and configs.
*
@@ -669,7 +672,7 @@ public class DistribCursorPagingTest extends AbstractFullDistribZkTestBase {
/**
* Given a QueryResponse returned by SolrServer.query, asserts that the
- * response does include {@link #CURSOR_MARK_NEXT} key and returns it
+ * response does include {@link CursorMarkParams#CURSOR_MARK_NEXT} key and returns it
* @see org.apache.solr.client.solrj.SolrClient#query
*/
private String assertHashNextCursorMark(QueryResponse rsp) {
@@ -686,8 +689,8 @@ public class DistribCursorPagingTest extends AbstractFullDistribZkTestBase {
/**
*
- * Given a set of params, executes a cursor query using {@link #CURSOR_MARK_START}
- * and then continuously walks the results using {@link #CURSOR_MARK_START} as long
+ * Given a set of params, executes a cursor query using {@link CursorMarkParams#CURSOR_MARK_START}
+ * and then continuously walks the results using {@link CursorMarkParams#CURSOR_MARK_START} as long
* as a non-0 number of docs ar returned. This method records the the set of all id's
* (must be postive ints) encountered and throws an assertion failure if any id is
* encountered more then once, or if the set grows above maxSize
diff --git a/solr/core/src/test/org/apache/solr/schema/IndexSchemaTest.java b/solr/core/src/test/org/apache/solr/schema/IndexSchemaTest.java
index 6d23beca521..2c0c6b03fe1 100644
--- a/solr/core/src/test/org/apache/solr/schema/IndexSchemaTest.java
+++ b/solr/core/src/test/org/apache/solr/schema/IndexSchemaTest.java
@@ -38,8 +38,8 @@ public class IndexSchemaTest extends SolrTestCaseJ4 {
/**
* This test assumes the schema includes:
- *
* Tests here create an index with a few documents, each having
* an indexed "id" field.
* The ord values of this field are later used for scoring.
- *
* The order tests use Hits to verify that docs are ordered as expected.
- *
* The exact score tests use TopDocs top to verify the exact score.
*/
public class TestOrdValues extends LuceneTestCase {
diff --git a/solr/core/src/test/org/apache/solr/update/processor/StatelessScriptUpdateProcessorFactoryTest.java b/solr/core/src/test/org/apache/solr/update/processor/StatelessScriptUpdateProcessorFactoryTest.java
index 7ea4b6b8157..191f5fc0e41 100644
--- a/solr/core/src/test/org/apache/solr/update/processor/StatelessScriptUpdateProcessorFactoryTest.java
+++ b/solr/core/src/test/org/apache/solr/update/processor/StatelessScriptUpdateProcessorFactoryTest.java
@@ -39,7 +39,7 @@ import java.util.List;
/**
* Tests {@link StatelessScriptUpdateProcessorFactory}.
*
- * TODO: This test, to run from an IDE, requires a working directory of
* "host1:2181"
- *
* "host1:2181,host2:2181,host3:2181/mysolrchroot"
- *
* "zoo1.example.com:2181,zoo2.example.com:2181,zoo3.example.com:2181"
*/
public CloudSolrClient(String zkHost) {
@@ -203,11 +203,11 @@ public class CloudSolrClient extends SolrClient {
* that starts with a forward slash. Using a chroot allows multiple
* applications to coexist in one ensemble. For full details, see the
* Zookeeper documentation. Some examples:
- *
* "host1:2181"
- *
* "host1:2181,host2:2181,host3:2181/mysolrchroot"
- *
* "zoo1.example.com:2181,zoo2.example.com:2181,zoo3.example.com:2181"
* @param httpClient
* the {@link HttpClient} instance to be used for all requests. The
diff --git a/solr/solrj/src/java/org/apache/solr/client/solrj/impl/HttpSolrClient.java b/solr/solrj/src/java/org/apache/solr/client/solrj/impl/HttpSolrClient.java
index ec49e46acfe..0499abbcae5 100644
--- a/solr/solrj/src/java/org/apache/solr/client/solrj/impl/HttpSolrClient.java
+++ b/solr/solrj/src/java/org/apache/solr/client/solrj/impl/HttpSolrClient.java
@@ -98,7 +98,7 @@ public class HttpSolrClient extends SolrClient {
/**
* Default value: null / empty.
- *
* Parameters that are added to every request regardless. This may be a place
* to add something like an authentication token.
*/
@@ -106,7 +106,7 @@ public class HttpSolrClient extends SolrClient {
/**
* Default response parser is BinaryResponseParser
- *
* This parser represents the default Response Parser chosen to parse the
* response if the parser were not specified as part of the request.
*
@@ -665,7 +665,7 @@ public class HttpSolrClient extends SolrClient {
}
/**
- * Allow server->client communication to be compressed. Currently gzip and
+ * Allow server->client communication to be compressed. Currently gzip and
* deflate are supported. If the server supports compression the response will
* be compressed. This method is only allowed if the http client is of type
* DefatulHttpClient.
diff --git a/solr/solrj/src/java/org/apache/solr/client/solrj/impl/LBHttpSolrClient.java b/solr/solrj/src/java/org/apache/solr/client/solrj/impl/LBHttpSolrClient.java
index 1c28f5a61e2..c6c591dbab1 100644
--- a/solr/solrj/src/java/org/apache/solr/client/solrj/impl/LBHttpSolrClient.java
+++ b/solr/solrj/src/java/org/apache/solr/client/solrj/impl/LBHttpSolrClient.java
@@ -51,11 +51,11 @@ import java.util.*;
* {@link CloudSolrClient}, but this class may be used
* for updates because the server will forward them to the appropriate leader.
*
- *
* It offers automatic failover when a server goes down and it detects when the server comes back up.
- *
* Load balancing is done using a simple round-robin on the list of servers.
- *
* If a request to a server fails by an IOException due to a connection timeout or read timeout then the host is taken
* off the list of live servers and moved to a 'dead server list' and the request is resent to the next live server.
* This process is continued till it tries all the live servers. If at least one server is alive, the request succeeds,
@@ -68,8 +68,8 @@ import java.util.*;
*
+ * When to use this?
- * See http://wiki.apache.org/solr/ExtractingRequestHandler
* A subclass can override the methods in this class to supply a custom format in which a request can be sent.
*
*
diff --git a/solr/solrj/src/java/org/apache/solr/client/solrj/response/AnalysisResponseBase.java b/solr/solrj/src/java/org/apache/solr/client/solrj/response/AnalysisResponseBase.java
index 1e399f381b9..21396a5d2a7 100644
--- a/solr/solrj/src/java/org/apache/solr/client/solrj/response/AnalysisResponseBase.java
+++ b/solr/solrj/src/java/org/apache/solr/client/solrj/response/AnalysisResponseBase.java
@@ -33,7 +33,7 @@ public class AnalysisResponseBase extends SolrResponseBase {
/**
* Parses the given named list and builds a list of analysis phases form it. Expects a named list of the form:
- *
+ *
* If this parameter is absent in the request then only one suggestion is
* returned. If it is more than one then a maximum of given suggestions are
* returned for each token in the query.
@@ -43,7 +43,7 @@ public interface SpellingParams {
/**
* The count of suggestions to return for each query term existing in the index and/or dictionary.
- *
* If this parameter is absent in the request then no suggestions are generated. This parameter allows
* for receiving alternative terms to use in context-sensitive spelling corrections.
*/
@@ -70,7 +70,7 @@ public interface SpellingParams {
* When this parameter is set to true and the misspelled word exists in the
* user field, only words that occur more frequently in the Solr field than
* the one given will be returned. The default value is false.
- *
* This is applicable only for dictionaries built from Solr fields.
*/
public static final String SPELLCHECK_ONLY_MORE_POPULAR = SPELLCHECK_PREFIX + "onlyMorePopular";
@@ -79,14 +79,14 @@ public interface SpellingParams {
* Whether to use the extended response format, which is more complicated but
* richer. Returns the document frequency for each suggestion and returns one
* suggestion block for each term in the query string. Default is false.
- *
* This is applicable only for dictionaries built from Solr fields.
*/
public static final String SPELLCHECK_EXTENDED_RESULTS = SPELLCHECK_PREFIX + "extendedResults";
/**
* Use the value for this parameter as the query to spell check.
- *
* This parameter is optional. If absent, then the q parameter is
* used.
*/
@@ -148,7 +148,7 @@ public interface SpellingParams {
/**
*
* Whether to use the Extended Results Format for collations.
- * Includes "before>after" pairs to easily allow clients to generate messages like "no results for PORK. did you mean POLK?"
+ * Includes "before>after" pairs to easily allow clients to generate messages like "no results for PORK. did you mean POLK?"
* Also indicates the # of hits each collation will return on re-query. Default=false, which retains 1.4-compatible output.
*
diff --git a/solr/solrj/src/java/org/apache/solr/common/util/DateUtil.java b/solr/solrj/src/java/org/apache/solr/common/util/DateUtil.java
index c77080ae8ef..49b7fc43f77 100644
--- a/solr/solrj/src/java/org/apache/solr/common/util/DateUtil.java
+++ b/solr/solrj/src/java/org/apache/solr/common/util/DateUtil.java
@@ -105,7 +105,7 @@ public class DateUtil {
/**
* Slightly modified from org.apache.commons.httpclient.util.DateUtil.parseDate
- *
* Parses the date value using the given date formats.
*
* @param dateValue the date value to parse
diff --git a/solr/solrj/src/java/org/apache/solr/common/util/FastOutputStream.java b/solr/solrj/src/java/org/apache/solr/common/util/FastOutputStream.java
index 502df3ce5c7..09a74417463 100644
--- a/solr/solrj/src/java/org/apache/solr/common/util/FastOutputStream.java
+++ b/solr/solrj/src/java/org/apache/solr/common/util/FastOutputStream.java
@@ -101,7 +101,7 @@ public class FastOutputStream extends OutputStream implements DataOutput {
/** reserve at least len bytes at the end of the buffer.
- * Invalid if len > buffer.length
+ * Invalid if len > buffer.length
*/
public void reserve(int len) throws IOException {
if (len > (buf.length - pos))
diff --git a/solr/solrj/src/java/org/apache/solr/common/util/Hash.java b/solr/solrj/src/java/org/apache/solr/common/util/Hash.java
index 81bfa95f4e5..81b5232ffeb 100644
--- a/solr/solrj/src/java/org/apache/solr/common/util/Hash.java
+++ b/solr/solrj/src/java/org/apache/solr/common/util/Hash.java
@@ -178,7 +178,7 @@ public class Hash {
/** This is the 64 bit version of lookup3ycs, corresponding to Bob Jenkin's
- * lookup3 hashlittle2 with initval biased by -(numCodePoints<<2). It is equivalent
+ * lookup3 hashlittle2 with initval biased by -(numCodePoints<<2). It is equivalent
* to lookup3ycs in that if the high bits of initval==0, then the low bits of the
* result will be the same as lookup3ycs.
*
* Note -- Never re-use an instance of this class for more than one marshal or unmarshall operation. Always create a new
* instance.
*/
@@ -732,7 +732,7 @@ public class JavaBinCodec {
/**
* Special method for variable length int (copied from lucene). Usually used for writing the length of a
- * collection/array/map In most of the cases the length can be represented in one byte (length < 127) so it saves 3
+ * collection/array/map In most of the cases the length can be represented in one byte (length < 127) so it saves 3
* bytes/object
*
* @throws IOException If there is a low-level I/O error.
diff --git a/solr/solrj/src/java/org/apache/solr/common/util/StrUtils.java b/solr/solrj/src/java/org/apache/solr/common/util/StrUtils.java
index e2b0cb24449..8ac87d7ec1f 100644
--- a/solr/solrj/src/java/org/apache/solr/common/util/StrUtils.java
+++ b/solr/solrj/src/java/org/apache/solr/common/util/StrUtils.java
@@ -78,7 +78,7 @@ public class StrUtils {
*
* Current backslash escaping supported:
*
* Characters with a numeric value less than 32 are encoded.
* &,=,%,+,space are encoded.
- *
*/
public static void partialURLEncodeVal(Appendable dest, String val) throws IOException {
for (int i=0; ifmap.title=solr.title
*
@@ -48,7 +48,7 @@ public interface ExtractingParams {
/**
* The boost value for the name of the field. The boost can be specified by a name mapping.
- *
+ *
* map.title=solr.title
@@ -73,9 +73,8 @@ public interface ExtractingParams {
* Restrict the extracted parts of a document to be indexed
* by passing in an XPath expression. All content that satisfies the XPath expr.
* will be passed to the {@link SolrContentHandler}.
- *
+ *
* <html>
diff --git a/solr/contrib/extraction/src/java/org/apache/solr/handler/extraction/ExtractingRequestHandler.java b/solr/contrib/extraction/src/java/org/apache/solr/handler/extraction/ExtractingRequestHandler.java
index b460849f03c..6d9e31b12a9 100644
--- a/solr/contrib/extraction/src/java/org/apache/solr/handler/extraction/ExtractingRequestHandler.java
+++ b/solr/contrib/extraction/src/java/org/apache/solr/handler/extraction/ExtractingRequestHandler.java
@@ -43,7 +43,6 @@ import java.util.Map;
/**
* Handler for rich documents like PDF or Word or any other file format that Tika handles that need the text to be extracted
* first from the document.
- *
*/
public class ExtractingRequestHandler extends ContentStreamHandlerBase implements SolrCoreAware {
diff --git a/solr/contrib/extraction/src/java/org/apache/solr/handler/extraction/SolrContentHandler.java b/solr/contrib/extraction/src/java/org/apache/solr/handler/extraction/SolrContentHandler.java
index fe1ecf59a64..49f8b89b172 100644
--- a/solr/contrib/extraction/src/java/org/apache/solr/handler/extraction/SolrContentHandler.java
+++ b/solr/contrib/extraction/src/java/org/apache/solr/handler/extraction/SolrContentHandler.java
@@ -38,8 +38,7 @@ import java.util.*;
/**
* The class responsible for handling Tika events and translating them into {@link org.apache.solr.common.SolrInputDocument}s.
* This class is not thread-safe.
- *
- *
+ *
+ *
* Important: Keep the method implementation as short as possible. If it were to use any heavy i/o , network connections -
* it might be a better idea to launch in a separate Thread so as to not to block the process of
* shutting down a given SolrCore instance.
@@ -42,9 +42,9 @@ public abstract class CloseHook {
/**
* Method called when the given SolrCore object has been shut down and update handlers and searchers are closed
- *
+ *
* Use this method for post-close clean up operations e.g. deleting the index from disk.
- *
+ *
* The core's passed to the method is already closed and therefore, its update handler or searcher should *NOT* be used
*
* Important: Keep the method implementation as short as possible. If it were to use any heavy i/o , network connections -
diff --git a/solr/core/src/java/org/apache/solr/core/Config.java b/solr/core/src/java/org/apache/solr/core/Config.java
index 7bd2126914c..c30b1cd2983 100644
--- a/solr/core/src/java/org/apache/solr/core/Config.java
+++ b/solr/core/src/java/org/apache/solr/core/Config.java
@@ -100,7 +100,7 @@ public class Config {
* will be created.
*
- *
*
*
- *
+ *
* <docs>
* <doc>
@@ -63,12 +63,10 @@ import java.util.*;
* ...
* </docs>
*
* Note: Each document must contain a field which serves as the unique key. This key is used in the returned
* response to associate an analysis breakdown to the analyzed document.
- *
- *
- *
+ *
+ *
*
* Name
* Type
diff --git a/solr/core/src/java/org/apache/solr/handler/ReplicationHandler.java b/solr/core/src/java/org/apache/solr/handler/ReplicationHandler.java
index 3cf1cdea3a7..f4ab68d9286 100644
--- a/solr/core/src/java/org/apache/solr/handler/ReplicationHandler.java
+++ b/solr/core/src/java/org/apache/solr/handler/ReplicationHandler.java
@@ -83,16 +83,16 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- *
+ * or command=disablepoll)
*
*
* @since solr 1.4
diff --git a/solr/core/src/java/org/apache/solr/handler/RequestHandlerBase.java b/solr/core/src/java/org/apache/solr/handler/RequestHandlerBase.java
index 00b847411ce..ad76ce2011c 100644
--- a/solr/core/src/java/org/apache/solr/handler/RequestHandlerBase.java
+++ b/solr/core/src/java/org/apache/solr/handler/RequestHandlerBase.java
@@ -62,7 +62,7 @@ public abstract class RequestHandlerBase implements SolrRequestHandler, SolrInfo
/**
* Initializes the {@link org.apache.solr.request.SolrRequestHandler} by creating three {@link org.apache.solr.common.params.SolrParams} named.
- *
+ *
*
* Name Description
* defaults Contains all of the named arguments contained within the list element named "defaults".
diff --git a/solr/core/src/java/org/apache/solr/handler/SnapPuller.java b/solr/core/src/java/org/apache/solr/handler/SnapPuller.java
index cb0325f90f3..b5f4697ede8 100644
--- a/solr/core/src/java/org/apache/solr/handler/SnapPuller.java
+++ b/solr/core/src/java/org/apache/solr/handler/SnapPuller.java
@@ -115,7 +115,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Provides functionality of downloading changed index files as well as config files and a timer for scheduling fetches from the
+ * appends Contains all of the named arguments contained within the list element named "appends".
*
By default - this method throws a
* solr exception. Derived classes are free to write their derivation if necessary.
*/
diff --git a/solr/core/src/java/org/apache/solr/handler/admin/ShowFileRequestHandler.java b/solr/core/src/java/org/apache/solr/handler/admin/ShowFileRequestHandler.java
index d9a8077df9c..aa1c68c32cd 100644
--- a/solr/core/src/java/org/apache/solr/handler/admin/ShowFileRequestHandler.java
+++ b/solr/core/src/java/org/apache/solr/handler/admin/ShowFileRequestHandler.java
@@ -57,7 +57,7 @@ import java.util.Set;
* If you want to selectively restrict access some configuration files, you can list
* these files in the {@link #HIDDEN} invariants. For example to hide
* synonyms.txt and anotherfile.txt, you would register:
- *
*
* <requestHandler name="/admin/file" class="org.apache.solr.handler.admin.ShowFileRequestHandler" >
* <lst name="defaults">
@@ -83,7 +83,7 @@ import java.util.Set;
* set it directly using: {@link #USE_CONTENT_TYPE}. For example, to get a plain text
* version of schema.xml, try:
*
- * http://localhost:8983/solr/admin/file?file=schema.xml&contentType=text/plain
+ * http://localhost:8983/solr/admin/file?file=schema.xml&contentType=text/plain
*
*
*
diff --git a/solr/core/src/java/org/apache/solr/handler/component/ExpandComponent.java b/solr/core/src/java/org/apache/solr/handler/component/ExpandComponent.java
index d5dad88a9ab..cf17fd986d5 100644
--- a/solr/core/src/java/org/apache/solr/handler/component/ExpandComponent.java
+++ b/solr/core/src/java/org/apache/solr/handler/component/ExpandComponent.java
@@ -92,17 +92,17 @@ import org.apache.solr.util.plugin.SolrCoreAware;
/**
* The ExpandComponent is designed to work with the CollapsingPostFilter.
* The CollapsingPostFilter collapses a result set on a field.
- *
+ *
- * expand.rows=5
- * expand.sort=field asc|desc
- * expand.q=*:* (optional, overrides the main query)
- * expand.fq=type:child (optional, overrides the main filter queries)
- * expand.field=field (mandatory if the not used with the CollapsingQParserPlugin)
+ *
+ * expand.rows=5
+ * expand.sort=field asc|desc
+ * expand.q=*:* (optional, overrides the main query)
+ * expand.fq=type:child (optional, overrides the main filter queries)
+ * expand.field=field (mandatory if the not used with the CollapsingQParserPlugin)
*/
public class ExpandComponent extends SearchComponent implements PluginInfoInitialized, SolrCoreAware {
public static final String COMPONENT_NAME = "expand";
diff --git a/solr/core/src/java/org/apache/solr/handler/component/FieldFacetStats.java b/solr/core/src/java/org/apache/solr/handler/component/FieldFacetStats.java
index f84a587f4f0..2887ce2cf27 100644
--- a/solr/core/src/java/org/apache/solr/handler/component/FieldFacetStats.java
+++ b/solr/core/src/java/org/apache/solr/handler/component/FieldFacetStats.java
@@ -39,7 +39,6 @@ import org.apache.solr.search.SolrIndexSearcher;
* for facet values present in another field.
*
diff --git a/solr/core/src/java/org/apache/solr/highlight/WeightedFragListBuilder.java b/solr/core/src/java/org/apache/solr/highlight/WeightedFragListBuilder.java
index b2ebe8ce5c3..6cc0da27b7c 100644
--- a/solr/core/src/java/org/apache/solr/highlight/WeightedFragListBuilder.java
+++ b/solr/core/src/java/org/apache/solr/highlight/WeightedFragListBuilder.java
@@ -1,4 +1,4 @@
-/**
+/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
diff --git a/solr/core/src/java/org/apache/solr/internal/csv/writer/CSVConfig.java b/solr/core/src/java/org/apache/solr/internal/csv/writer/CSVConfig.java
index ac67123fe8b..625eb9facb4 100644
--- a/solr/core/src/java/org/apache/solr/internal/csv/writer/CSVConfig.java
+++ b/solr/core/src/java/org/apache/solr/internal/csv/writer/CSVConfig.java
@@ -144,7 +144,7 @@ public class CSVConfig {
/**
* Set the fill pattern. Defaults to {@link #FILLNONE}
- *
Other options are : {@link #FILLLEFT} and {@link #FILLRIGHT}
+ *
Other options are : {@link #FILLLEFT} and {@link #FILLRIGHT}
* @param fill the fill pattern.
*/
public void setFill(int fill) {
@@ -258,7 +258,7 @@ public class CSVConfig {
}
/**
- * Creates a config based on a stream. It tries to guess
+ * Creates a config based on a stream. It tries to guess
* NOTE : The stream will be closed.
* @param inputStream the inputstream.
* @return the guessed config.
diff --git a/solr/core/src/java/org/apache/solr/logging/log4j/EventAppender.java b/solr/core/src/java/org/apache/solr/logging/log4j/EventAppender.java
index 1e8b6f01790..88755ca27b2 100644
--- a/solr/core/src/java/org/apache/solr/logging/log4j/EventAppender.java
+++ b/solr/core/src/java/org/apache/solr/logging/log4j/EventAppender.java
@@ -1,4 +1,4 @@
-/**
+/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
diff --git a/solr/core/src/java/org/apache/solr/logging/log4j/Log4jInfo.java b/solr/core/src/java/org/apache/solr/logging/log4j/Log4jInfo.java
index a1c28a5c2c3..9df6a6a7556 100644
--- a/solr/core/src/java/org/apache/solr/logging/log4j/Log4jInfo.java
+++ b/solr/core/src/java/org/apache/solr/logging/log4j/Log4jInfo.java
@@ -1,4 +1,4 @@
-/**
+/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
diff --git a/solr/core/src/java/org/apache/solr/logging/log4j/Log4jWatcher.java b/solr/core/src/java/org/apache/solr/logging/log4j/Log4jWatcher.java
index c137b659fc7..e484a97ffb3 100644
--- a/solr/core/src/java/org/apache/solr/logging/log4j/Log4jWatcher.java
+++ b/solr/core/src/java/org/apache/solr/logging/log4j/Log4jWatcher.java
@@ -1,4 +1,4 @@
-/**
+/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
diff --git a/solr/core/src/java/org/apache/solr/parser/SolrQueryParserBase.java b/solr/core/src/java/org/apache/solr/parser/SolrQueryParserBase.java
index abe1bb0b6a9..b76ce09591e 100644
--- a/solr/core/src/java/org/apache/solr/parser/SolrQueryParserBase.java
+++ b/solr/core/src/java/org/apache/solr/parser/SolrQueryParserBase.java
@@ -271,7 +271,7 @@ public abstract class SolrQueryParserBase extends QueryBuilder {
* Sets the boolean operator of the QueryParser.
* In default mode (OR_OPERATOR
) terms without any modifiers
* are considered optional: for example capital of Hungary
is equal to
- * capital OR of OR Hungary
.
+ * capital OR of OR Hungary
.
* In AND_OPERATOR
mode terms are considered to be in conjunction: the
* above mentioned query is parsed as capital AND of AND Hungary
*/
diff --git a/solr/core/src/java/org/apache/solr/request/IntervalFacets.java b/solr/core/src/java/org/apache/solr/request/IntervalFacets.java
index 90c838157e0..862a4be0251 100644
--- a/solr/core/src/java/org/apache/solr/request/IntervalFacets.java
+++ b/solr/core/src/java/org/apache/solr/request/IntervalFacets.java
@@ -53,7 +53,7 @@ import org.apache.solr.search.SyntaxError;
/**
* Computes interval facets for docvalues field (single or multivalued).
- *
+ *
* Intervals must begin with either '(' or '[', be followed by the start value,
* then a comma ',', the end value, and finally ')' or ']'. For example:
*
@@ -89,7 +89,7 @@ import org.apache.solr.search.SyntaxError;
* As with facet.query, the key used to display the result can be set by using local params
* syntax, for example:
{!key='First Half'}[0,5)
- *
* IntervalFacets intervalFacets = new IntervalFacets(schemaField, searcher, docs, intervalStrs, params);
diff --git a/solr/core/src/java/org/apache/solr/request/SimpleFacets.java b/solr/core/src/java/org/apache/solr/request/SimpleFacets.java
index 297fb8e181e..0a5e124842d 100644
--- a/solr/core/src/java/org/apache/solr/request/SimpleFacets.java
+++ b/solr/core/src/java/org/apache/solr/request/SimpleFacets.java
@@ -1245,7 +1245,7 @@ public class SimpleFacets {
}
/**
- * A simple key=>val pair whose natural order is such that
+ * A simple key=>val pair whose natural order is such that
* higher vals come before lower vals.
* In case of tie vals, then lower keys come before higher keys.
*/
diff --git a/solr/core/src/java/org/apache/solr/request/UnInvertedField.java b/solr/core/src/java/org/apache/solr/request/UnInvertedField.java
index bab1eddc9c2..64d8f8267a9 100644
--- a/solr/core/src/java/org/apache/solr/request/UnInvertedField.java
+++ b/solr/core/src/java/org/apache/solr/request/UnInvertedField.java
@@ -462,7 +462,7 @@ public class UnInvertedField extends DocTermOrds {
/**
* Collect statistics about the UninvertedField. Code is very similar to {@link #getCounts(org.apache.solr.search.SolrIndexSearcher, org.apache.solr.search.DocSet, int, int, Integer, boolean, String, String)}
* It can be used to calculate stats on multivalued fields.
- *
+ *
+ * Note On Returnable Data...
* A SolrQueryResponse
may contain the following types of
* Objects generated by the SolrRequestHandler
that processed
* the request.
diff --git a/solr/core/src/java/org/apache/solr/response/transform/DocTransformer.java b/solr/core/src/java/org/apache/solr/response/transform/DocTransformer.java
index bcfba99e8ca..183042dc035 100644
--- a/solr/core/src/java/org/apache/solr/response/transform/DocTransformer.java
+++ b/solr/core/src/java/org/apache/solr/response/transform/DocTransformer.java
@@ -26,7 +26,7 @@ import org.apache.solr.request.SolrQueryRequest;
* A DocTransformer can add, remove or alter a Document before it is written out to the Response. For instance, there are implementations
* that can put explanations inline with a document, add constant values and mark items as being artificially boosted (see {@link org.apache.solr.handler.component.QueryElevationComponent})
*
- *
*
+ *
* Implementations depend on a delegating work to a sub {@link org.apache.solr.schema.FieldType}, specified by
* either the {@link #SUB_FIELD_SUFFIX} or the {@link #SUB_FIELD_TYPE} (the latter is used if both are defined.
- *
+ *
* Example:
* <fieldType name="xy" class="solr.PointType" dimension="2" subFieldType="double"/>
*
* In theory, classes deriving from this should be able to do things like represent a point, a polygon, a line, etc.
- *
+ *
* NOTE: There can only be one sub Field Type.
*
*/
diff --git a/solr/core/src/java/org/apache/solr/schema/ExternalFileField.java b/solr/core/src/java/org/apache/solr/schema/ExternalFileField.java
index 98e76af4d4d..3f0e28aad4a 100644
--- a/solr/core/src/java/org/apache/solr/schema/ExternalFileField.java
+++ b/solr/core/src/java/org/apache/solr/schema/ExternalFileField.java
@@ -30,7 +30,7 @@ import java.util.Map;
/** Get values from an external file instead of the index.
*
- * keyField
will normally be the unique key field, but it doesn't have to be.
+ * keyField
will normally be the unique key field, but it doesn't have to be.
*
Example:
- * doc33=1.414
- * doc34=3.14159
- * doc40=42
+ *
Example:
+ * doc33=1.414
+ * doc34=3.14159
+ * doc40=42
*
- * Solr looks for the external file in the index directory under the name of
+ *
- * <listener event="newSearcher" class="org.apache.solr.schema.ExternalFileFieldReloader"/>
- * <listener event="firstSearcher" class="org.apache.solr.schema.ExternalFileFieldReloader"/>
+ * <listener event="newSearcher" class="org.apache.solr.schema.ExternalFileFieldReloader"/>
+ * <listener event="firstSearcher" class="org.apache.solr.schema.ExternalFileFieldReloader"/>
*
*
* The caches will be reloaded for all ExternalFileFields in your schema after
diff --git a/solr/core/src/java/org/apache/solr/schema/FieldType.java b/solr/core/src/java/org/apache/solr/schema/FieldType.java
index 09c7c2f220b..6ac68c02d87 100644
--- a/solr/core/src/java/org/apache/solr/schema/FieldType.java
+++ b/solr/core/src/java/org/apache/solr/schema/FieldType.java
@@ -231,7 +231,7 @@ public abstract class FieldType extends FieldProperties {
* (taken from toInternal()). Having a different representation for
* external, internal, and indexed would present quite a few problems
* given the current Lucene architecture. An analyzer for adding docs
- * would need to translate internal->indexed while an analyzer for
+ * would need to translate internal->indexed while an analyzer for
* querying would need to translate external->indexed.
* ScriptEngine
diff --git a/solr/core/src/java/org/apache/solr/update/processor/TimestampUpdateProcessorFactory.java b/solr/core/src/java/org/apache/solr/update/processor/TimestampUpdateProcessorFactory.java
index 64d91d5ac63..1dca49dc509 100644
--- a/solr/core/src/java/org/apache/solr/update/processor/TimestampUpdateProcessorFactory.java
+++ b/solr/core/src/java/org/apache/solr/update/processor/TimestampUpdateProcessorFactory.java
@@ -42,7 +42,7 @@ import org.apache.solr.common.params.CommonParams; // javadoc
* In the example configuration below, if a document does not contain a value
* in the timestamp
field, a new Date
will be
* generated and added as the value of that field.
- *
*
*
* <processor class="solr.TimestampUpdateProcessorFactory">
diff --git a/solr/core/src/java/org/apache/solr/update/processor/UUIDUpdateProcessorFactory.java b/solr/core/src/java/org/apache/solr/update/processor/UUIDUpdateProcessorFactory.java
index e099f04fd08..ee2709fed03 100644
--- a/solr/core/src/java/org/apache/solr/update/processor/UUIDUpdateProcessorFactory.java
+++ b/solr/core/src/java/org/apache/solr/update/processor/UUIDUpdateProcessorFactory.java
@@ -40,7 +40,7 @@ import org.apache.solr.schema.SchemaField;
* In the example configuration below, if a document does not contain a value
* in the
id
field, a new UUID
will be generated
* and added as the value of that field.
- *
*
*
* <processor class="solr.UUIDUpdateProcessorFactory">
@@ -54,7 +54,6 @@ import org.apache.solr.schema.SchemaField;
* is used as field and a new
* This detects if a dead server comes alive automatically. The check is done in fixed intervals in a dedicated thread.
* This interval can be set using {@link #setAliveCheckInterval} , the default is set to one minute.
- *
- * When to use this?UUID
will be generated
* and added as the value of that field. The field type of the uniqueKeyField
* must be anything which accepts a string or UUID value.
- *
if b==false, removes all other terms parameters
+ * @param b flag to indicate terms should be enabled.
if b==false, removes all other terms parameters
* @return Current reference (this)
*/
public SolrQuery setTerms(boolean b) {
@@ -319,7 +319,7 @@ public class SolrQuery extends ModifiableSolrParams
*
* @param name Name of the facet field to be removed.
*
- * @return true, if the item was removed.
+ * @return true, if the item was removed.
* false, if the facet field was null or did not exist.
*/
public boolean removeFacetField(String name) {
@@ -332,7 +332,7 @@ public class SolrQuery extends ModifiableSolrParams
/** enable/disable faceting.
*
- * @param b flag to indicate faceting should be enabled.
if b==false, removes all other faceting parameters
+ * @param b flag to indicate faceting should be enabled.
if b==false, removes all other faceting parameters
* @return Current reference (this)
*/
public SolrQuery setFacet(boolean b) {
@@ -475,7 +475,7 @@ public class SolrQuery extends ModifiableSolrParams
/** remove a field for highlighting
*
* @param f field name to not highlight
- * @return true, if removed,
false, otherwise
+ * @return true, if removed,
false, otherwise
*/
public boolean removeHighlightField(String f) {
boolean b = this.remove(HighlightParams.FIELDS, f);
diff --git a/solr/solrj/src/java/org/apache/solr/client/solrj/impl/CloudSolrClient.java b/solr/solrj/src/java/org/apache/solr/client/solrj/impl/CloudSolrClient.java
index fe1e58746cd..809ca124eae 100644
--- a/solr/solrj/src/java/org/apache/solr/client/solrj/impl/CloudSolrClient.java
+++ b/solr/solrj/src/java/org/apache/solr/client/solrj/impl/CloudSolrClient.java
@@ -171,11 +171,11 @@ public class CloudSolrClient extends SolrClient {
* that starts with a forward slash. Using a chroot allows multiple
* applications to coexist in one ensemble. For full details, see the
* Zookeeper documentation. Some examples:
- *
+ *
This can be used as a software load balancer when you do not wish to setup an external
+ *
This can be used as a software load balancer when you do not wish to setup an external
* load balancer. Alternatives to this code are to use
* a dedicated hardware load balancer or using Apache httpd with mod_proxy_balancer as a load balancer. See Load balancing on Wikipedia
diff --git a/solr/solrj/src/java/org/apache/solr/client/solrj/request/ContentStreamUpdateRequest.java b/solr/solrj/src/java/org/apache/solr/client/solrj/request/ContentStreamUpdateRequest.java
index 6b02486c956..2697e3f0493 100644
--- a/solr/solrj/src/java/org/apache/solr/client/solrj/request/ContentStreamUpdateRequest.java
+++ b/solr/solrj/src/java/org/apache/solr/client/solrj/request/ContentStreamUpdateRequest.java
@@ -31,7 +31,7 @@ import java.util.List;
* Basic functionality to upload a File or {@link org.apache.solr.common.util.ContentStream} to a Solr Cell or some
* other handler that takes ContentStreams (CSV)
*
+ * See http://wiki.apache.org/solr/ExtractingRequestHandler
* See http://wiki.apache.org/solr/UpdateCSV
*
*
diff --git a/solr/solrj/src/java/org/apache/solr/client/solrj/request/RequestWriter.java b/solr/solrj/src/java/org/apache/solr/client/solrj/request/RequestWriter.java
index a33fe7e377a..15872b25bc7 100644
--- a/solr/solrj/src/java/org/apache/solr/client/solrj/request/RequestWriter.java
+++ b/solr/solrj/src/java/org/apache/solr/client/solrj/request/RequestWriter.java
@@ -32,7 +32,7 @@ import java.nio.charset.StandardCharsets;
/**
* A RequestWriter is used to write requests to Solr.
- *
*
* <lst name="index">
* <arr name="Tokenizer">
@@ -78,7 +78,7 @@ public class AnalysisResponseBase extends SolrResponseBase {
/**
* Parses the given named list and builds a token infoform it. Expects a named list of the form:
- *
+ *
*
* <arr name="Tokenizer">
* <str name="text">the_text</str>
diff --git a/solr/solrj/src/java/org/apache/solr/client/solrj/util/ClientUtils.java b/solr/solrj/src/java/org/apache/solr/client/solrj/util/ClientUtils.java
index 9f33d6f962e..bfefb3a18e2 100644
--- a/solr/solrj/src/java/org/apache/solr/client/solrj/util/ClientUtils.java
+++ b/solr/solrj/src/java/org/apache/solr/client/solrj/util/ClientUtils.java
@@ -184,9 +184,10 @@ public class ClientUtils
//---------------------------------------------------------------------------------------
/**
- * See: {@link org.apache.lucene.queryparser.classic queryparser syntax}
+ * See: Lucene query parser syntax
* for more information on Escaping Special Characters
*/
+ // NOTE: its broken to link to any lucene-queryparser.jar docs, not in classpath!!!!!
public static String escapeQueryChars(String s) {
StringBuilder sb = new StringBuilder();
for (int i = 0; i < s.length(); i++) {
diff --git a/solr/solrj/src/java/org/apache/solr/common/SolrDocument.java b/solr/solrj/src/java/org/apache/solr/common/SolrDocument.java
index f0a713f6a17..b7e4465220b 100644
--- a/solr/solrj/src/java/org/apache/solr/common/SolrDocument.java
+++ b/solr/solrj/src/java/org/apache/solr/common/SolrDocument.java
@@ -214,7 +214,7 @@ public class SolrDocument implements Map
*
*
+ *
* See http://wiki.apache.org/solr/DocTransformers
*/
String EDITORIAL_MARKER_FIELD_NAME = "editorialMarkerFieldName";
@@ -40,7 +40,7 @@ public interface QueryElevationParams {
* The name of the field that excluded editorial results will be written out as when using the QueryElevationComponent, which
* automatically configures the EditorialMarkerFactory. The default name is "excluded". This is only used
* when {@link #MARK_EXCLUDES} is set to true at query time.
- *
+ *
* See http://wiki.apache.org/solr/DocTransformers
*/
String EXCLUDE_MARKER_FIELD_NAME = "excludeMarkerFieldName";
diff --git a/solr/solrj/src/java/org/apache/solr/common/params/SpellingParams.java b/solr/solrj/src/java/org/apache/solr/common/params/SpellingParams.java
index 27fb4e10fc6..918592d20cf 100644
--- a/solr/solrj/src/java/org/apache/solr/common/params/SpellingParams.java
+++ b/solr/solrj/src/java/org/apache/solr/common/params/SpellingParams.java
@@ -34,7 +34,7 @@ public interface SpellingParams {
/**
* The count of suggestions to return for each query term not in the index and/or dictionary.
- *
+ *
\n \t \r \b \f are escaped the same as a Java String
- *
Other characters following a backslash are produced verbatim (\c => c)
+ *
Other characters following a backslash are produced verbatim (\c => c)
*
* @param s the string to split
* @param separator the separator to split on
@@ -258,7 +258,6 @@ public class StrUtils {
*