com.github.healthonnet.synonyms.NoBoostSolrParams Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hon-lucene-synonyms Show documentation

Enables proper query-time synonym expansion, with no reindexing required.

There is a newer version: 5.0.5

/**
 * 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.
 * The ASF 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 com.github.healthonnet.synonyms;

import java.util.Iterator;

import com.github.healthonnet.search.SynonymExpandingExtendedDismaxQParserPlugin;
import org.apache.solr.common.params.DisMaxParams;
import org.apache.solr.common.params.SolrParams;

import com.google.common.collect.ImmutableSet;

/**
 * Extends a set of solr params, hiding the boost-related parameters (bq, bf, boost).  This is useful
 * for constructing the synonym queries using the superclass, because we don't want to boost them artificially
 * 
 * @see issue 31
 * @author nolan
 *
 */
@SuppressWarnings("serial")
public class NoBoostSolrParams extends SolrParams {

    private static final ImmutableSet BOOST_PARAMS = ImmutableSet.of(
            DisMaxParams.BQ, DisMaxParams.BF, SynonymExpandingExtendedDismaxQParserPlugin.Params.MULT_BOOST);
    
    private SolrParams delegateParams;
    
    private NoBoostSolrParams(SolrParams delegate) {
        this.delegateParams = delegate;
    }
    
    @Override
    public String get(String param) {
        if (param != null && param.equals(DisMaxParams.MM)) {
            if (delegateParams.getBool(SynonymExpandingExtendedDismaxQParserPlugin.Params.SYNONYMS_IGNORE_MM, false)) {
                return null;
            }
        }
        return delegateParams.get(param);
    }

    @Override
    public String[] getParams(String param) {
        if (param != null && BOOST_PARAMS.contains(param)) {
            return null;
        }
        return delegateParams.getParams(param);
    }

    @Override
    public Iterator getParameterNamesIterator() {
        return delegateParams.getParameterNamesIterator();
    }
    
    public static NoBoostSolrParams wrap(SolrParams delegateParams) {
        return delegateParams == null ? null : new NoBoostSolrParams(delegateParams);
    }
}