simplify plugin registration of custom queries and filters

modules/elasticsearch/src/main/java/org/elasticsearch/index/query/IndexQueryParserModule.java

@@ -20,6 +20,7 @@
 package org.elasticsearch.index.query;
 
 import org.elasticsearch.common.collect.Lists;
+import org.elasticsearch.common.collect.Maps;
 import org.elasticsearch.common.inject.AbstractModule;
 import org.elasticsearch.common.inject.Scopes;
 import org.elasticsearch.common.inject.assistedinject.FactoryProvider;
@@ -109,11 +110,33 @@ public class IndexQueryParserModule extends AbstractModule {
 
     private final LinkedList<QueryParsersProcessor> processors = Lists.newLinkedList();
 
+    private final Map<String, Class<? extends QueryParser>> queries = Maps.newHashMap();
+    private final Map<String, Class<? extends FilterParser>> filters = Maps.newHashMap();
 
     public IndexQueryParserModule(Settings settings) {
         this.settings = settings;
     }
 
+    /**
+     * Adds a custom query parser.
+     *
+     * @param name        The name of the query parser
+     * @param queryParser the class of the query parser
+     */
+    public void addQueryParser(String name, Class<? extends QueryParser> queryParser) {
+        queries.put(name, queryParser);
+    }
+
+    /**
+     * Adds a custom filter parser.
+     *
+     * @param name         The name of the filter parser
+     * @param filterParser the class of the filter parser
+     */
+    public void addFilterParser(String name, Class<? extends FilterParser> filterParser) {
+        filters.put(name, filterParser);
+    }
+
     public IndexQueryParserModule addProcessor(QueryParsersProcessor processor) {
         processors.addFirst(processor);
         return this;
@@ -143,6 +166,10 @@ public class IndexQueryParserModule extends AbstractModule {
             processor.processXContentQueryParsers(xContentQueryParsersBindings);
         }
 
+        for (Map.Entry<String, Class<? extends QueryParser>> entry : queries.entrySet()) {
+            queryBinder.addBinding(entry.getKey()).toProvider(FactoryProvider.newFactory(QueryParserFactory.class, entry.getValue())).in(Scopes.SINGLETON);
+        }
+
         // handle XContentFilterParsers
         MapBinder<String, FilterParserFactory> filterBinder
                 = MapBinder.newMapBinder(binder(), String.class, FilterParserFactory.class);
@@ -162,5 +189,9 @@ public class IndexQueryParserModule extends AbstractModule {
         for (QueryParsersProcessor processor : processors) {
             processor.processXContentFilterParsers(xContentFilterParsersBindings);
         }
+
+        for (Map.Entry<String, Class<? extends FilterParser>> entry : filters.entrySet()) {
+            filterBinder.addBinding(entry.getKey()).toProvider(FactoryProvider.newFactory(FilterParserFactory.class, entry.getValue())).in(Scopes.SINGLETON);
+        }
     }
 }

modules/elasticsearch/src/main/java/org/elasticsearch/indices/query/IndicesQueriesRegistry.java

@@ -25,7 +25,6 @@ import org.elasticsearch.common.inject.Inject;
 import org.elasticsearch.common.settings.Settings;
 import org.elasticsearch.index.query.*;
 
-import java.util.HashMap;
 import java.util.Map;
 
 /**
@@ -33,11 +32,11 @@ import java.util.Map;
  */
 public class IndicesQueriesRegistry {
 
-    private final ImmutableMap<String, QueryParser> queryParsers;
+    private ImmutableMap<String, QueryParser> queryParsers;
-    private final ImmutableMap<String, FilterParser> filterParsers;
+    private ImmutableMap<String, FilterParser> filterParsers;
 
     @Inject public IndicesQueriesRegistry(Settings settings) {
-        HashMap<String, QueryParser> queryParsers = Maps.newHashMap();
+        Map<String, QueryParser> queryParsers = Maps.newHashMap();
         addQueryParser(queryParsers, new TextQueryParser());
         addQueryParser(queryParsers, new HasChildQueryParser());
         addQueryParser(queryParsers, new TopChildrenQueryParser());
@@ -69,7 +68,7 @@ public class IndicesQueriesRegistry {
         addQueryParser(queryParsers, new FuzzyLikeThisFieldQueryParser());
         this.queryParsers = ImmutableMap.copyOf(queryParsers);
 
-        HashMap<String, FilterParser> filterParsers = Maps.newHashMap();
+        Map<String, FilterParser> filterParsers = Maps.newHashMap();
         addFilterParser(filterParsers, new HasChildFilterParser());
         addFilterParser(filterParsers, new TypeFilterParser());
         addFilterParser(filterParsers, new IdsFilterParser());
@@ -96,6 +95,21 @@ public class IndicesQueriesRegistry {
         this.filterParsers = ImmutableMap.copyOf(filterParsers);
     }
 
+    /**
+     * Adds a global query parser.
+     */
+    public void addQueryParser(QueryParser queryParser) {
+        Map<String, QueryParser> queryParsers = Maps.newHashMap(this.queryParsers);
+        addQueryParser(queryParsers, queryParser);
+        this.queryParsers = ImmutableMap.copyOf(queryParsers);
+    }
+
+    public void addFilterParser(FilterParser filterParser) {
+        Map<String, FilterParser> filterParsers = Maps.newHashMap(this.filterParsers);
+        addFilterParser(filterParsers, filterParser);
+        this.filterParsers = ImmutableMap.copyOf(filterParsers);
+    }
+
     public ImmutableMap<String, QueryParser> queryParsers() {
         return queryParsers;
     }

modules/elasticsearch/src/test/java/org/elasticsearch/index/query/plugin/IndexQueryParserPlugin2Tests.java

@@ -0,0 +1,80 @@
+/*
+ * Licensed to Elastic Search and Shay Banon under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. Elastic Search licenses this
+ * file to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.elasticsearch.index.query.plugin;
+
+import org.elasticsearch.common.inject.Injector;
+import org.elasticsearch.common.inject.ModulesBuilder;
+import org.elasticsearch.common.settings.ImmutableSettings;
+import org.elasticsearch.common.settings.Settings;
+import org.elasticsearch.common.settings.SettingsModule;
+import org.elasticsearch.index.Index;
+import org.elasticsearch.index.IndexNameModule;
+import org.elasticsearch.index.analysis.AnalysisModule;
+import org.elasticsearch.index.cache.IndexCacheModule;
+import org.elasticsearch.index.engine.IndexEngineModule;
+import org.elasticsearch.index.query.IndexQueryParserModule;
+import org.elasticsearch.index.query.IndexQueryParserService;
+import org.elasticsearch.index.settings.IndexSettingsModule;
+import org.elasticsearch.index.similarity.SimilarityModule;
+import org.elasticsearch.indices.query.IndicesQueriesModule;
+import org.elasticsearch.script.ScriptModule;
+import org.elasticsearch.threadpool.ThreadPoolModule;
+import org.testng.annotations.Test;
+
+import static org.hamcrest.MatcherAssert.*;
+import static org.hamcrest.Matchers.*;
+
+/**
+ * @author kimchy (shay.banon)
+ */
+public class IndexQueryParserPlugin2Tests {
+
+    @Test public void testCustomInjection() {
+        Settings settings = ImmutableSettings.Builder.EMPTY_SETTINGS;
+
+        IndexQueryParserModule queryParserModule = new IndexQueryParserModule(settings);
+        queryParserModule.addQueryParser("my", PluginJsonQueryParser.class);
+        queryParserModule.addFilterParser("my", PluginJsonFilterParser.class);
+
+        Index index = new Index("test");
+        Injector injector = new ModulesBuilder().add(
+                new SettingsModule(settings),
+                new ThreadPoolModule(settings),
+                new IndicesQueriesModule(),
+                new ScriptModule(settings),
+                new IndexSettingsModule(index, settings),
+                new IndexCacheModule(settings),
+                new AnalysisModule(settings),
+                new IndexEngineModule(settings),
+                new SimilarityModule(settings),
+                queryParserModule,
+                new IndexNameModule(index)
+        ).createInjector();
+
+        IndexQueryParserService indexQueryParserService = injector.getInstance(IndexQueryParserService.class);
+
+        PluginJsonQueryParser myJsonQueryParser = (PluginJsonQueryParser) indexQueryParserService.queryParser("my");
+
+        assertThat(myJsonQueryParser.names()[0], equalTo("my"));
+
+        PluginJsonFilterParser myJsonFilterParser = (PluginJsonFilterParser) indexQueryParserService.filterParser("my");
+        assertThat(myJsonFilterParser.names()[0], equalTo("my"));
+    }
+}