org.xlrnet.metadict.core.query.QueryRequestBuilder.java Source code

Introduction

Here is the source code for org.xlrnet.metadict.core.query.QueryRequestBuilder.java

Source

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 Jakob Hende
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package org.xlrnet.metadict.core.query;

import com.google.common.collect.Lists;
import org.apache.commons.lang3.StringUtils;
import org.jetbrains.annotations.NotNull;
import org.xlrnet.metadict.api.language.BilingualDictionary;
import org.xlrnet.metadict.api.language.Language;
import org.xlrnet.metadict.core.aggregation.GroupingType;
import org.xlrnet.metadict.core.aggregation.OrderType;

import java.util.HashSet;
import java.util.List;
import java.util.Set;

import static com.google.common.base.Preconditions.checkNotNull;

/**
 * Builder for creating new {@link QueryRequest} objects.
 */
public class QueryRequestBuilder {

    private String queryString;

    private Set<BilingualDictionary> queryDictionaries = new HashSet<>();

    private GroupingType groupingType = GroupingType.NONE;

    private OrderType orderType = OrderType.RELEVANCE;

    private Set<Language> queryLanguages = new HashSet<>();

    private boolean autoDeriveMonolingualLanguages = false;

    /**
     * Adds a new {@link BilingualDictionary} to the current query.
     *
     * @param newDictionary
     *         The new dictionary to add.
     * @return the current builder
     */
    public QueryRequestBuilder addQueryDictionary(@NotNull BilingualDictionary newDictionary) {
        checkNotNull(newDictionary);

        this.queryDictionaries.add(newDictionary);
        return this;
    }

    /**
     * Adds a new {@link Language} for monolingual lookups to the current query.
     *
     * @param newLanguage
     *         The new language to add.
     * @return the current builder
     */
    public QueryRequestBuilder addQueryLanguage(@NotNull Language newLanguage) {
        checkNotNull(newLanguage);

        this.queryLanguages.add(newLanguage);
        return this;
    }

    public QueryRequest build() {
        if (this.autoDeriveMonolingualLanguages) {
            for (BilingualDictionary d : this.queryDictionaries) {
                this.queryLanguages.add(d.getSource());
                this.queryLanguages.add(d.getTarget());
            }
        }

        return new ImmutableQueryRequest(this.queryString, Lists.newArrayList(this.queryDictionaries),
                this.groupingType, this.orderType, Lists.newArrayList(this.queryLanguages));
    }

    /**
     * If set to true, the builder will create automatically a new monolingual language entry for each added bilingual
     * dictionary upon calling {@link #build()}. This feature is helpful if you don't want to call always the {@link
     * #addQueryLanguage(Language)} for bilingual queries.
     *
     * @param autoDeriveMonolingualLanguages
     *         If set to true, the builder will create automatically a new monolingual language entry for each added
     *         bilingual dictionary upon calling build().
     * @return the current builder
     */
    public QueryRequestBuilder setAutoDeriveMonolingualLanguages(boolean autoDeriveMonolingualLanguages) {
        this.autoDeriveMonolingualLanguages = autoDeriveMonolingualLanguages;
        return this;
    }

    /**
     * Set the grouping type that should be used for the result set. If none is set, the grouping type {@link
     * GroupingType#NONE} will be used as default.
     *
     * @param groupingType
     *         The grouping type that should be used for the result set.
     * @return the current builder
     */
    public QueryRequestBuilder setGroupBy(GroupingType groupingType) {
        checkNotNull(groupingType);

        this.groupingType = groupingType;
        return this;
    }

    /**
     * Set the order type that should be used for the result set. If none is set, the order type {@link
     * OrderType#RELEVANCE} will be used as default.
     *
     * @param orderType
     *         The order type that should be used for the result set.
     * @return the current builder
     */
    public QueryRequestBuilder setOrderBy(OrderType orderType) {
        checkNotNull(orderType);

        this.orderType = orderType;
        return this;
    }

    /**
     * Sets all {@link BilingualDictionary} objects that should be queried.
     *
     * @param dictionaries
     *         The dictionaries to query.
     * @return the current builder
     */
    public QueryRequestBuilder setQueryDictionaries(@NotNull List<BilingualDictionary> dictionaries) {
        checkNotNull(dictionaries);

        for (BilingualDictionary dictionary : dictionaries)
            checkNotNull(dictionary);

        this.queryDictionaries.addAll(dictionaries);
        return this;
    }

    /**
     * Set the query string for this request. This is usually the string that will be forwarded to the search backend.
     *
     * @param queryString
     *         The query string for this request.
     * @return the current builder
     */
    public QueryRequestBuilder setQueryString(@NotNull String queryString) {
        checkNotNull(queryString);

        this.queryString = StringUtils.lowerCase(queryString);
        return this;
    }
}