com.hp.mqm.atrf.alm.services.AlmQueryBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of alm-test-result-collection-tool Show documentation
The newest version!
/*
 *     Copyright 2017 Hewlett-Packard Development Company, L.P.
 *     Licensed 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.hp.mqm.atrf.alm.services;

import com.hp.mqm.atrf.core.rest.HTTPUtils;
import org.apache.commons.lang.SerializationUtils;
import org.apache.commons.lang.StringUtils;

import java.io.Serializable;
import java.util.*;

/**
 * Created by berkovir on 06/12/2016.
 */
public class AlmQueryBuilder implements Serializable {


    private StringBuilder sb;
    private Integer pageSize;
    private Integer startIndex;
    private List selectedFields;
    private List orderBy;
    private Map queryConditions;

    public static final String PREPARED_FILTER = "_PREPARED_FILTER_";

    public static AlmQueryBuilder create() {
        return new AlmQueryBuilder();
    }

    public AlmQueryBuilder addQueryConditions(Map conditions) {
        if (conditions != null && !conditions.isEmpty()) {
            if (this.queryConditions == null) {
                this.queryConditions = new HashMap<>();
            }
            this.queryConditions.putAll(conditions);
        }
        return this;
    }

    public AlmQueryBuilder addQueryCondition(String field, String value) {
        if (queryConditions == null) {
            queryConditions = new HashMap<>();
        }
        queryConditions.put(field, value);
        return this;
    }

    public AlmQueryBuilder addStartIndex(Integer startIndex) {
        this.startIndex = startIndex;
        return this;
    }

    public AlmQueryBuilder addPageSize(int pageSize) {
        this.pageSize = pageSize;
        return this;
    }

    public AlmQueryBuilder addSelectedFields(String... fieldNames) {
        return addSelectedFields(Arrays.asList(fieldNames));
    }

    public AlmQueryBuilder addSelectedFields(Collection fieldNames) {
        if (fieldNames != null && !fieldNames.isEmpty()) {
            if (selectedFields == null) {
                selectedFields = new ArrayList<>();
            }
            selectedFields.addAll(fieldNames);
        }
        return this;
    }

    public AlmQueryBuilder addOrderBy(String... fieldNames) {
        return addOrderBy(Arrays.asList(fieldNames));
    }

    public AlmQueryBuilder addOrderBy(Collection fieldNames) {
        if (fieldNames != null && !fieldNames.isEmpty()) {
            if (orderBy == null) {
                orderBy = new ArrayList<>();
            }
            orderBy.addAll(fieldNames);
        }
        return this;
    }

    public String build() {
        sb = new StringBuilder();
        buildPageSize();
        buildStartIndex();
        buildQuery();
        buildSelectedFields();
        buildOrderBy();
        return sb.toString();
    }

    private void buildSelectedFields() {
        if (selectedFields != null && !selectedFields.isEmpty()) {
            sb.append("&").append("fields=").append(StringUtils.join(selectedFields, ","));
        }
    }

    private void buildQuery() {
        if (queryConditions != null && !queryConditions.isEmpty()) {
            String splitter = "";
            sb.append("&").append("query={");
            if (queryConditions != null) {
                for (Map.Entry entry : queryConditions.entrySet()) {
                    sb.append(splitter);

                    if (entry.getKey().equals(PREPARED_FILTER)) {
                        sb.append(HTTPUtils.encodeParam(entry.getValue()));
                    } else {
                        //if value contains spaces (for example A OR B), spaces should be converted to '+',
                        //if value wrapped with ' , vor example 'Not Completed', it should be handled as is
                        //String value = entry.getValue().startsWith("'") ? entry.getValue() : entry.getValue().replaceAll(" ", "+");

                        sb.append(entry.getKey()).append("[").append(HTTPUtils.encodeParam(entry.getValue())).append("]");
                    }
                    splitter = ";";

                }
            }

            sb.append("}");
        }
    }

    private void buildStartIndex() {
        if (startIndex != null) {
            sb.append("&").append("start-index=").append(startIndex);
        }
    }

    private void buildPageSize() {
        if (pageSize != null) {
            sb.append("&").append("page-size=").append(pageSize);
        }
    }

    private void buildOrderBy() {
        if (orderBy != null && !orderBy.isEmpty()) {
            sb.append("&").append("order-by=").append("{").append(StringUtils.join(orderBy, ",")).append("}");
        }
    }


    public Map getQueryConditions() {
        return queryConditions;
    }

    public AlmQueryBuilder clone() {
        AlmQueryBuilder qb = (AlmQueryBuilder) SerializationUtils.clone(this);
        return qb;
    }
}