HashSplitterPlugin.java

/*
 * 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.plugin.hashsplitter;

import org.elasticsearch.common.inject.Module;
import org.elasticsearch.index.analysis.AnalysisModule;
import org.elasticsearch.index.analysis.HashSplitterAnalysisBinderProcessor;
import org.elasticsearch.indices.query.IndicesQueriesModule;
import org.elasticsearch.plugin.mapper.hashsplitter.HashSplitterIndexModule;
import org.elasticsearch.plugin.mapper.hashsplitter.HashSplitterIndexQueryParserModule;
import org.elasticsearch.plugins.AbstractPlugin;

import java.util.Collection;

import static org.elasticsearch.common.collect.Lists.newArrayList;

/**
 * @author ofavre
 */
public class HashSplitterPlugin extends AbstractPlugin {
    
    @Override
    public String name() {
        return "hashsplitter";
    }

    @Override
    public String description() {
        return "Analysis and mapper plugin that can split long hash or ids into multiple parts and query it, useful for huge indices";
    }

    @Override
    public void processModule(Module module) {
        if (module instanceof AnalysisModule) {
            AnalysisModule analysisModule = (AnalysisModule) module;
            analysisModule.addProcessor(new HashSplitterAnalysisBinderProcessor());
        }
    }

    @Override
    public Collection<Class<? extends Module>> indexModules() {
        Collection<Class<? extends Module>> modules = newArrayList();
        modules.add(HashSplitterIndexModule.class);
        modules.add(HashSplitterIndexQueryParserModule.class);
        return modules;
    }

}