You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by mi...@apache.org on 2013/12/28 13:56:39 UTC
svn commit: r1553821 - in
/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server:
./ handlers/ http/ params/ plugins/
Author: mikemccand
Date: Sat Dec 28 12:56:38 2013
New Revision: 1553821
URL: http://svn.apache.org/r1553821
Log:
LUCENE-5376: javadocs
Modified:
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/DirectoryFactory.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/FinishRequest.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/FromFileTermFreqIterator.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/GenFileUtil.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/GlobalState.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/IndexState.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/MultiFacetsAccumulator.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/PreHandle.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/RecencyBlendedFieldComparatorSource.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/TopFacetsCache.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/WholeMVJSONPassageFormatter.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/AnalysisHandler.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/BulkAddDocumentHandler.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/BulkAddDocumentsHandler.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/BulkUpdateDocumentsHandler.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/DocHandler.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/LiveSettingsHandler.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/RegisterFieldHandler.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/SearchHandler.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/SettingsHandler.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/http/HttpStaticFileServerHandler.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/AnyType.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/BooleanType.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/FloatType.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/IntType.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/ListType.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/LongType.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/OrType.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/Request.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/RequestFailedException.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/StringType.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/StructType.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/WrapType.java
lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/plugins/Plugin.java
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/DirectoryFactory.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/DirectoryFactory.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/DirectoryFactory.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/DirectoryFactory.java Sat Dec 28 12:56:38 2013
@@ -31,6 +31,12 @@ import org.apache.lucene.store.SimpleFSD
/** A factory to open a {@link Directory} from a provided
* filesystem path. */
public abstract class DirectoryFactory {
+
+ /** Sole constructor. */
+ public DirectoryFactory() {
+ }
+
+ /** Open a new {@link Directory} at the specified path. */
public abstract Directory open(File path) throws IOException;
/** Returns an instance, using the specified
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/FinishRequest.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/FinishRequest.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/FinishRequest.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/FinishRequest.java Sat Dec 28 12:56:38 2013
@@ -24,5 +24,7 @@ package org.apache.lucene.server;
* process so that we can fail if there are unhandled
* params, without having made any changes to the index. */
public interface FinishRequest {
+
+ /** Perform the actual work of the request. */
public String finish() throws Exception;
}
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/FromFileTermFreqIterator.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/FromFileTermFreqIterator.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/FromFileTermFreqIterator.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/FromFileTermFreqIterator.java Sat Dec 28 12:56:38 2013
@@ -33,7 +33,10 @@ public class FromFileTermFreqIterator im
private final BufferedReader reader;
private long weight;
private int lineCount;
+
+ /** How many suggestions were found. */
public int suggestCount;
+
private BytesRef extra;
/** Sole constructor. */
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/GenFileUtil.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/GenFileUtil.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/GenFileUtil.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/GenFileUtil.java Sat Dec 28 12:56:38 2013
@@ -31,7 +31,7 @@ import org.apache.lucene.util.IOUtils;
// TODO: move to Lucene (eg PSDP could use this)
/** Helper class for write-once save/load of state to a
- * Directory, ie foo_0, foo_1, ... */
+ * {@link Directory}, ie foo.0, foo.1, ... */
public abstract class GenFileUtil<T> {
private final String prefix;
@@ -39,15 +39,18 @@ public abstract class GenFileUtil<T> {
private long nextWriteGen;
+ /** Sole constructor. */
protected GenFileUtil(Directory dir, String prefix) {
this.dir = dir;
this.prefix = prefix + ".";
}
+ /** Next generation to write. */
public long getNextWriteGen() {
return nextWriteGen;
}
+ /** Loads the most recent generation file. */
protected synchronized T load() throws IOException {
long genLoaded = -1;
IOException ioe = null;
@@ -108,10 +111,13 @@ public abstract class GenFileUtil<T> {
return loaded;
}
+ /** True if this generation is no longer in use; subclass
+ * can override this to implement a "deletion policy". */
protected boolean canDelete(long gen) {
return true;
}
+ /** Save the object to the next write generation. */
public synchronized void save(T o) throws IOException {
String fileName = prefix + nextWriteGen;
@@ -145,7 +151,9 @@ public abstract class GenFileUtil<T> {
nextWriteGen++;
}
+ /** Load the object from the provided {@link IndexInput}. */
protected abstract T loadOne(IndexInput in) throws IOException;
+ /** Save the object to the provided {@link IndexOutput}. */
protected abstract void saveOne(IndexOutput out, T obj) throws IOException;
}
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/GlobalState.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/GlobalState.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/GlobalState.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/GlobalState.java Sat Dec 28 12:56:38 2013
@@ -52,7 +52,37 @@ import net.minidev.json.JSONValue;
import net.minidev.json.parser.ParseException;
/** Holds all global state for the server. Per-index state
- * is held in {@link IndexState}. */
+ * is held in {@link IndexState}.
+ *
+ * <p> Filesystem state ($stateDir is the "global state
+ * dir", passed to GlobalState on init):
+ *
+ * <ul>
+ * <li> $stateDir/indices.gen: holds map of indexName to
+ * root filesystem path for that index
+ * <li> $stateDir/plugins: a directory with one
+ * sub-directory per plugin
+ * </ul>
+ *
+ * Each plugin sub-directory ($stateDir/plugins/foo/)
+ * defines one plugin, and contains:
+ * <ul>
+ * <li> lucene-server-plugin.properties:
+ * file with the properties for plugin {@code foo};
+ * alternatively, the properties file can be inside a
+ * *.zip or *.jar in the plugin directory. This must
+ * define the property "class" with the fully qualified
+ * path to the Plugin class to instantiate
+ * <li> $stateDir/plugins/foo/lib/*: optional, contains
+ * *.jar to add to the classpath while loading the
+ * plugin
+ * <li> $stateDir/plugins/*.zip or *.jar contains the
+ * plugins class files and optionally the properties
+ * file
+ * </ul>
+
+ * Each index has its own indexDir, specified when the index
+ * is created; see {@link IndexState} for details. */
public class GlobalState implements Closeable {
private static final String PLUGIN_PROPERTIES_FILE = "lucene-server-plugin.properties";
@@ -102,7 +132,9 @@ public class GlobalState implements Clos
}
/** Record a new handler, by methode name (search,
- * addDocument, etc.). */
+ * addDocument, etc.). The server registers all builtin
+ * handlers on startup, but plugins can also register
+ * their own handlers when they are instantiated. */
public void addHandler(String name, Handler handler) {
if (handlers.containsKey(name)) {
throw new IllegalArgumentException("handler \"" + name + "\" is already defined");
@@ -111,7 +143,7 @@ public class GlobalState implements Clos
}
/** Retrieve a handler by method name (search,
- * addDocument, etc.). */
+ * addDocument, etc.). */
public Handler getHandler(String name) {
Handler h = handlers.get(name);
if (h == null) {
@@ -299,9 +331,10 @@ public class GlobalState implements Clos
System.out.println("Start plugin " + pluginDir.getAbsolutePath());
- // add the root
+ // Add the plugin's root
addURL.invoke(classLoader, pluginDir.toURI().toURL());
+ // Add any .jar/.zip in the plugin's root directory:
for(File pluginFile : pluginFiles) {
if (pluginFile.getName().endsWith(".jar") ||
pluginFile.getName().endsWith(".zip")) {
@@ -309,6 +342,8 @@ public class GlobalState implements Clos
}
}
+ // Add any .jar files in the plugin's lib sub
+ // directory, if it exists:
File pluginLibDir = new File(pluginDir, "lib");
if (pluginLibDir.exists()) {
File[] pluginLibFiles = pluginLibDir.listFiles();
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/IndexState.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/IndexState.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/IndexState.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/IndexState.java Sat Dec 28 12:56:38 2013
@@ -107,7 +107,26 @@ import net.minidev.json.JSONStyleIdent;
import net.minidev.json.JSONValue;
import net.minidev.json.parser.ParseException;
-/** Holds all state associated with one index. */
+/** Holds all state associated with one index. On startup
+ * and on creating a new index, the index loads its state
+ * but does not start itself. At this point, setting can
+ * be changed, and then the index must be {@link start}ed
+ * before it can be used for indexing and searching, at
+ * which point only live settings may be changed.
+ *
+ * Filesystem state: each index has its own rootDir,
+ * specified when the index is created. Under each
+ * rootDir:
+ * <ul>
+ * <li> {@code index} has the Lucene index
+ * <li> {@code taxonomy} has the taxonomy index (empty if
+ * no facets are indexed)
+ * <li> {@code state} has all current settings
+ * <li> {@code state/state.N} gen files holds all settings
+ * <li> {@code state/saveLoadRefCounts.N} gen files holds
+ * all reference counts from live snapshots
+ * </ul>
+ */
public class IndexState implements Closeable {
// nocommit settingsHandler should set this
@@ -146,7 +165,7 @@ public class IndexState implements Close
/** All live values fields. */
public final Map<String,StringLiveFieldValues> liveFieldValues = new ConcurrentHashMap<String,StringLiveFieldValues>();
- /** Maps gen -> version */
+ /** Maps snapshot gen -> version. */
public final Map<Long,Long> snapshotGenToVersion = new ConcurrentHashMap<Long,Long>();
/** Built suggest implementations */
@@ -191,6 +210,7 @@ public class IndexState implements Close
}
};
+ /** Tracks snapshot references to generations. */
private static class SaveLoadRefCounts extends GenFileUtil<Map<Long,Integer>> {
public SaveLoadRefCounts(Directory dir) {
@@ -391,7 +411,9 @@ public class IndexState implements Close
private final boolean isNew;
- /** Sole constructor. */
+ /** Sole constructor; creates a new index or loads an
+ * existing one if it exists, but does not start the
+ * index. */
public IndexState(GlobalState globalState, String name, File rootDir) throws Exception {
this.globalState = globalState;
this.name = name;
@@ -435,6 +457,10 @@ public class IndexState implements Close
/** Which document index hit each error. */
public final List<Integer> errorIndex = new ArrayList<Integer>();
+ /** Sole constructor. */
+ public AddDocumentContext() {
+ }
+
/** Record an exception. */
public synchronized void addException(int index, Exception e) {
StringWriter sw = new StringWriter();
@@ -724,6 +750,10 @@ public class IndexState implements Close
/** Facets. */
public List<CategoryPath> facets;
+
+ /** Sole constructor. */
+ public DocumentAndFacets() {
+ }
}
/** Create a new {@code AddDocumentJob}. */
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/MultiFacetsAccumulator.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/MultiFacetsAccumulator.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/MultiFacetsAccumulator.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/MultiFacetsAccumulator.java Sat Dec 28 12:56:38 2013
@@ -40,10 +40,12 @@ public class MultiFacetsAccumulator exte
private final RangeAccumulator ra;
private final FacetSearchParams fspOrig;
+ /** Create this, using default FacetArrays. */
public static FacetsAccumulator create(FacetSearchParams fsp, IndexReader indexReader, TaxonomyReader taxoReader) {
return create(fsp, indexReader, taxoReader, new FacetArrays(taxoReader.getSize()));
}
+ /** Create this, using the provided FacetArrays. */
public static FacetsAccumulator create(FacetSearchParams fsp, IndexReader indexReader, TaxonomyReader taxoReader, FacetArrays arrays) {
List<FacetRequest> rangeRequests = new ArrayList<FacetRequest>();
List<FacetRequest> nonRangeRequests = new ArrayList<FacetRequest>();
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/PreHandle.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/PreHandle.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/PreHandle.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/PreHandle.java Sat Dec 28 12:56:38 2013
@@ -26,5 +26,7 @@ import org.apache.lucene.server.params.R
* pre-process requests. */
public interface PreHandle {
+
+ /** Invoked before the selected handler runs. */
public void invoke(Request request) throws Exception;
}
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/RecencyBlendedFieldComparatorSource.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/RecencyBlendedFieldComparatorSource.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/RecencyBlendedFieldComparatorSource.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/RecencyBlendedFieldComparatorSource.java Sat Dec 28 12:56:38 2013
@@ -33,6 +33,7 @@ public class RecencyBlendedFieldComparat
final long range;
final long currentTime;
+ /** Sole constructor. */
public RecencyBlendedFieldComparatorSource(String timeStampFieldName, float maxBoost, long currentTime, long range) {
this.timeStampFieldName = timeStampFieldName;
this.maxBoost = maxBoost;
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/TopFacetsCache.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/TopFacetsCache.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/TopFacetsCache.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/TopFacetsCache.java Sat Dec 28 12:56:38 2013
@@ -34,11 +34,19 @@ public class TopFacetsCache {
// caching ...:
private final Map<FacetRequest,FacetResult> cache = new ConcurrentHashMap<FacetRequest,FacetResult>();
+ /** Sole constructor. */
+ public TopFacetsCache() {
+ }
+
+ /** Returns a {@link FacetResult} from the cache, or null
+ * if the request was not previously cached. */
public FacetResult get(FacetRequest request) {
// System.out.println("GET: " + cache.size() + " entries");
return cache.get(request);
}
+ /** Add an entry to the cache if it's not already
+ * present. */
public void add(FacetRequest request, FacetResult result) {
if (!cache.containsKey(request)) {
cache.put(request, result);
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/WholeMVJSONPassageFormatter.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/WholeMVJSONPassageFormatter.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/WholeMVJSONPassageFormatter.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/WholeMVJSONPassageFormatter.java Sat Dec 28 12:56:38 2013
@@ -28,6 +28,7 @@ public class WholeMVJSONPassageFormatter
private final int offsetGap;
+ /** Create this, with the specified offsetGap. */
public WholeMVJSONPassageFormatter(int offsetGap) {
this.offsetGap = offsetGap;
}
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/AnalysisHandler.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/AnalysisHandler.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/AnalysisHandler.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/AnalysisHandler.java Sat Dec 28 12:56:38 2013
@@ -44,6 +44,7 @@ public class AnalysisHandler extends Han
new Param("text", "Text to analyze", new StringType()),
new Param("analyzer", "Analyzer", RegisterFieldHandler.ANALYZER_TYPE));
+ /** Sole constructor. */
public AnalysisHandler(GlobalState state) {
super(state);
}
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/BulkAddDocumentHandler.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/BulkAddDocumentHandler.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/BulkAddDocumentHandler.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/BulkAddDocumentHandler.java Sat Dec 28 12:56:38 2013
@@ -44,6 +44,7 @@ public class BulkAddDocumentHandler exte
new Param("indexName", "Index name", new StringType()),
new Param("documents", "List of documents", new ListType(AddDocumentHandler.DOCUMENT_TYPE)));
+ /** Sole constructor. */
public BulkAddDocumentHandler(GlobalState state) {
super(state);
}
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/BulkAddDocumentsHandler.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/BulkAddDocumentsHandler.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/BulkAddDocumentsHandler.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/BulkAddDocumentsHandler.java Sat Dec 28 12:56:38 2013
@@ -51,6 +51,7 @@ public class BulkAddDocumentsHandler ext
new Param("children", "List of child documents.",
new ListType(AddDocumentHandler.DOCUMENT_TYPE))))));
+ /** Sole constructor. */
public BulkAddDocumentsHandler(GlobalState state) {
super(state);
}
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/BulkUpdateDocumentsHandler.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/BulkUpdateDocumentsHandler.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/BulkUpdateDocumentsHandler.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/BulkUpdateDocumentsHandler.java Sat Dec 28 12:56:38 2013
@@ -56,6 +56,7 @@ public class BulkUpdateDocumentsHandler
new Param("children", "List of child documents.",
new ListType(AddDocumentHandler.DOCUMENT_TYPE))))));
+ /** Sole constructor. */
public BulkUpdateDocumentsHandler(GlobalState state) {
super(state);
}
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/DocHandler.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/DocHandler.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/DocHandler.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/DocHandler.java Sat Dec 28 12:56:38 2013
@@ -45,6 +45,10 @@ import org.apache.lucene.server.params.W
* handlers. */
public class DocHandler {
+ /** Sole constructor. */
+ public DocHandler() {
+ }
+
// nocommit this is wasteful ... use Apache commons?
private static String escapeHTML(String s) {
s = s.replaceAll("&", "&");
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/LiveSettingsHandler.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/LiveSettingsHandler.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/LiveSettingsHandler.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/LiveSettingsHandler.java Sat Dec 28 12:56:38 2013
@@ -29,6 +29,7 @@ import org.apache.lucene.server.params.*
* the index is running. */
public class LiveSettingsHandler extends Handler {
+ /** The parameters this handler accepts. */
public final static StructType TYPE =
new StructType(
new Param("indexName", "The index", new StringType()),
@@ -47,6 +48,7 @@ public class LiveSettingsHandler extends
return "Change global offline or online settings for this index.";
}
+ /** Sole constructor. */
public LiveSettingsHandler(GlobalState state) {
super(state);
}
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/RegisterFieldHandler.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/RegisterFieldHandler.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/RegisterFieldHandler.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/RegisterFieldHandler.java Sat Dec 28 12:56:38 2013
@@ -363,6 +363,7 @@ public class RegisterFieldHandler extend
new Param("fields", "New fields to register",
new StructType(new Param("*", "Register this field name with the provided type. Note that the field name must be of the form [a-zA-Z_][a-zA-Z_0-9]*. You can register multiple fields in one request.", FIELD_TYPE))));
+ /** Sole constructor. */
public RegisterFieldHandler(GlobalState state) {
super(state);
}
@@ -990,6 +991,7 @@ public class RegisterFieldHandler extend
return analyzer;
}
+ /** Parses a Lucene version constant. */
@SuppressWarnings("deprecation")
public static Version getVersion(String v) {
if (v.equals("LUCENE_40")) {
@@ -1000,6 +1002,12 @@ public class RegisterFieldHandler extend
return Version.LUCENE_42;
} else if (v.equals("LUCENE_43")) {
return Version.LUCENE_43;
+ } else if (v.equals("LUCENE_44")) {
+ return Version.LUCENE_44;
+ } else if (v.equals("LUCENE_45")) {
+ return Version.LUCENE_45;
+ } else if (v.equals("LUCENE_46")) {
+ return Version.LUCENE_46;
} else {
throw new IllegalArgumentException("unhandled version " + v);
}
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/SearchHandler.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/SearchHandler.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/SearchHandler.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/SearchHandler.java Sat Dec 28 12:56:38 2013
@@ -399,15 +399,24 @@ public class SearchHandler extends Handl
super(state);
}
+ /** Holds the state for a single {@link
+ * PostingsHighlighter} instance. */
public final class HighlighterConfig {
PostingsHighlighter highlighter;
int maxPassages;
String config;
- // Holds field values for all documents we loaded for
- // this request:
+ /** Sole constructor. */
+ public HighlighterConfig() {
+ }
+
+ /** Holds field values for all documents we loaded for
+ * this request. */
Map<Integer,Map<String,Object>> docsCache = new HashMap<Integer,Map<String,Object>>();
+ /** Load the fiels for a single document, using the
+ * cache so we only ever load a document once from
+ * Lucene. */
@SuppressWarnings("unchecked")
public Map<String,Object> getDocument(IndexState state, IndexSearcher searcher, int docID) throws IOException {
Map<String,Object> doc = docsCache.get(docID);
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/SettingsHandler.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/SettingsHandler.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/SettingsHandler.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/handlers/SettingsHandler.java Sat Dec 28 12:56:38 2013
@@ -39,6 +39,7 @@ public class SettingsHandler extends Han
// TODO: add "includeDefaults" bool ... if true then we
// return ALL settings (incl default ones)
+ /** Parameters accepted by this handler. */
public static final StructType TYPE =
new StructType(
new Param("indexName", "Index name", new StringType()),
@@ -67,6 +68,7 @@ public class SettingsHandler extends Han
return "Change global offline settings for this index. This returns the currently set settings; pass no settings changes to retrieve current settings.";
}
+ /** Sole constructor. */
public SettingsHandler(GlobalState state) {
super(state);
}
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/http/HttpStaticFileServerHandler.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/http/HttpStaticFileServerHandler.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/http/HttpStaticFileServerHandler.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/http/HttpStaticFileServerHandler.java Sat Dec 28 12:56:38 2013
@@ -108,12 +108,18 @@ import static org.jboss.netty.handler.co
*/
public class HttpStaticFileServerHandler extends SimpleChannelUpstreamHandler {
+ /** HTTP header format. */
public static final String HTTP_DATE_FORMAT = "EEE, dd MMM yyyy HH:mm:ss zzz";
+
+ /** HTTP header timezone. */
public static final String HTTP_DATE_GMT_TIMEZONE = "GMT";
+
+ /** How long the client should cache a static file. */
public static final int HTTP_CACHE_SECONDS = 60;
private final File rootDir;
+ /** Sole constructor. */
public HttpStaticFileServerHandler(File rootDir) throws IOException {
this.rootDir = rootDir.getCanonicalFile();
}
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/AnyType.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/AnyType.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/AnyType.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/AnyType.java Sat Dec 28 12:56:38 2013
@@ -20,6 +20,10 @@ package org.apache.lucene.server.params;
/** Accepts any object. */
public class AnyType extends Type {
+ /** Sole constructor. */
+ public AnyType() {
+ }
+
@Override
public void validate(Object o) {
}
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/BooleanType.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/BooleanType.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/BooleanType.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/BooleanType.java Sat Dec 28 12:56:38 2013
@@ -20,6 +20,10 @@ package org.apache.lucene.server.params;
/** Type for booleans. */
public class BooleanType extends Type {
+ /** Sole constructor. */
+ public BooleanType() {
+ }
+
@Override
public void validate(Object o) {
if (!(o instanceof Boolean)) {
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/FloatType.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/FloatType.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/FloatType.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/FloatType.java Sat Dec 28 12:56:38 2013
@@ -22,6 +22,10 @@ import java.math.BigDecimal;
/** Type for any number that could be a double. */
public class FloatType extends Type {
+ /** Sole constructor. */
+ public FloatType() {
+ }
+
@Override
public void validate(Object o) {
// nocommit messy:
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/IntType.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/IntType.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/IntType.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/IntType.java Sat Dec 28 12:56:38 2013
@@ -20,6 +20,10 @@ package org.apache.lucene.server.params;
/** Type for an integer. */
public class IntType extends Type {
+ /** Sole constructor. */
+ public IntType() {
+ }
+
@Override
public void validate(Object o) {
if (!(o instanceof Integer)) {
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/ListType.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/ListType.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/ListType.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/ListType.java Sat Dec 28 12:56:38 2013
@@ -21,6 +21,8 @@ import java.util.List;
/** Type for a list of items of fixed subType. */
public class ListType extends Type {
+
+ /** Type of our elements. */
public final Type subType;
/** Sole constructor. */
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/LongType.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/LongType.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/LongType.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/LongType.java Sat Dec 28 12:56:38 2013
@@ -20,6 +20,10 @@ package org.apache.lucene.server.params;
/** Type for a long. */
public class LongType extends Type {
+ /** Sole constructor. */
+ public LongType() {
+ }
+
@Override
public void validate(Object o) {
if (!(o instanceof Long) && !(o instanceof Integer)) {
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/OrType.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/OrType.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/OrType.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/OrType.java Sat Dec 28 12:56:38 2013
@@ -19,6 +19,8 @@ package org.apache.lucene.server.params;
/** Type that accepts any of the provided list of types. */
public class OrType extends Type {
+
+ /** Allowed sub-types. */
public final Type[] types;
/** Sole constructor. */
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/Request.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/Request.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/Request.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/Request.java Sat Dec 28 12:56:38 2013
@@ -436,6 +436,9 @@ public class Request {
return null;
}
+ /** Retrieve a list parameter. Once this is called for a
+ * given parameter it cannot be called again on that
+ * parameter. */
@SuppressWarnings("unchecked")
public List<Object> getList(String name) {
Param p = type.params.get(name);
@@ -506,6 +509,8 @@ public class Request {
}
}
+ /** True if this request has any bindings, excluding
+ * empty containers. */
public static boolean anythingLeft(JSONObject obj) {
Iterator<Map.Entry<String,Object>> it = obj.entrySet().iterator();
boolean anything = false;
@@ -560,14 +565,20 @@ public class Request {
return sb.toString();
}
+ /** Throws a {@link RequestFailedException} with the
+ * provided message. */
public void fail(String message) {
fail(null, message, null);
}
+ /** Throws a {@link RequestFailedException} with the
+ * provided parameter and message. */
public void fail(String param, String message) {
fail(param, message, null);
}
+ /** Throws a {@link RequestFailedException} with the
+ * provided parameter and message and original cause. */
public void fail(String param, String reason, Throwable cause) {
StringBuilder sb = new StringBuilder();
buildPath(sb);
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/RequestFailedException.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/RequestFailedException.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/RequestFailedException.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/RequestFailedException.java Sat Dec 28 12:56:38 2013
@@ -17,12 +17,27 @@ package org.apache.lucene.server.params;
* limitations under the License.
*/
+// nocommit rename to InvalidRequestExc?
+
+/** Exception thrown on an invalid request. */
public class RequestFailedException extends IllegalArgumentException {
+
+ /** The request that contains the failure. */
public final Request request;
+
+ /** Which parameter led to the failure, if any (can be
+ * null). */
public final String param;
+
+ /** The full path leading to the parameter (e.g.,
+ * sort.fields[0].field). */
public final String path;
+
+ /** The specific reason for the failure (e.g., "expected
+ * int but got string"). */
public final String reason;
+ /** Creates this. */
public RequestFailedException(Request r, String param, String path, String reason) {
super(path + ": " + reason);
this.request = r;
@@ -31,6 +46,8 @@ public class RequestFailedException exte
this.reason = reason;
}
+ /** Creates this from another {@code
+ * RequestFailedException}, adding further details. */
public RequestFailedException(RequestFailedException other, String details) {
super(other.reason + ": " + details);
this.reason = other.reason + ": " + details;
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/StringType.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/StringType.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/StringType.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/StringType.java Sat Dec 28 12:56:38 2013
@@ -17,8 +17,13 @@ package org.apache.lucene.server.params;
* limitations under the License.
*/
+/** Type for a string. */
public class StringType extends Type {
+ /** Sole constructor. */
+ public StringType() {
+ }
+
@Override
public void validate(Object o) {
if (!(o instanceof String)) {
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/StructType.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/StructType.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/StructType.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/StructType.java Sat Dec 28 12:56:38 2013
@@ -22,9 +22,13 @@ import java.util.Map;
import net.minidev.json.JSONObject;
+/** Type for a structure containing named typed parameters. */
public class StructType extends Type {
+
+ /** Parameters contained in this struct. */
public final Map<String,Param> params = new HashMap<String,Param>();
+ /** Sole constructor. */
public StructType(Param... params) {
boolean sawPoly = false;
for(Param p : params) {
@@ -41,6 +45,7 @@ public class StructType extends Type {
}
}
+ /** Add another parameter. */
public void addParam(Param param) {
if (params.containsKey(param.name)) {
throw new IllegalArgumentException("param name \"" + param.name + "\" already exists");
@@ -48,6 +53,7 @@ public class StructType extends Type {
params.put(param.name, param);
}
+ @Override
public void validate(Object _o) {
if (!(_o instanceof JSONObject)) {
throw new IllegalArgumentException("expected struct but got " + _o.getClass());
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/WrapType.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/WrapType.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/WrapType.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/params/WrapType.java Sat Dec 28 12:56:38 2013
@@ -21,6 +21,11 @@ package org.apache.lucene.server.params;
public class WrapType extends Type {
private Type other;
+ /** Sole constructor. */
+ public WrapType() {
+ }
+
+ /** Set our wrapped type. */
public void set(Type other) {
if (this.other != null) {
throw new IllegalStateException("already set");
@@ -34,6 +39,7 @@ public class WrapType extends Type {
other.validate(o);
}
+ /** Return the type we wrap. */
public Type getWrappedType() {
return other;
}
Modified: lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/plugins/Plugin.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/plugins/Plugin.java?rev=1553821&r1=1553820&r2=1553821&view=diff
==============================================================================
--- lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/plugins/Plugin.java (original)
+++ lucene/dev/branches/lucene5376/lucene/server/src/java/org/apache/lucene/server/plugins/Plugin.java Sat Dec 28 12:56:38 2013
@@ -17,7 +17,16 @@ package org.apache.lucene.server.plugins
* limitations under the License.
*/
+/** Base class for all plugins. */
public abstract class Plugin {
+
+ /** Sole constructor. */
+ public Plugin() {
+ }
+
+ /** Name of this plugin. */
public abstract String getName();
+
+ /** Documentation for this plugin (English). */
public abstract String getTopDoc();
}