com.apitable.client.api.model.ApiQueryParam Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of apitable-client Show documentation
APITable Sdk Client
The newest version!
/*
 * Copyright (c) 2021 apitable, https://apitable.com 
 *
 * 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 com.apitable.client.api.model;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.apitable.core.utils.UrlEncoder;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;

import static com.apitable.client.api.Constants.CELL_FORMAT;
import static com.apitable.client.api.Constants.FIELDS;
import static com.apitable.client.api.Constants.FIELD_KEY;
import static com.apitable.client.api.Constants.FILTER_BY_FORMULA;
import static com.apitable.client.api.Constants.MAX_RECORDS;
import static com.apitable.client.api.Constants.PAGE_NUM;
import static com.apitable.client.api.Constants.PAGE_SIZE;
import static com.apitable.client.api.Constants.RECORD_IDS;
import static com.apitable.client.api.Constants.SORT;
import static com.apitable.client.api.Constants.VIEW_ID;

public class ApiQueryParam extends HashMap> {

    public static ApiQueryParam newInstance() {
        return new ApiQueryParam();
    }

    public ApiQueryParam() {
        super(16);
    }

    public ApiQueryParam(HashMap> map) {
        super(map);
    }

    public ApiQueryParam(int page, int pageSize) {
        super(16);
        withParam(PAGE_NUM, Integer.toString(page));
        withParam(PAGE_SIZE, Integer.toString(pageSize));
    }

    public ApiQueryParam withSort(String fieldName, Order order) {
        List values = computeIfAbsent(UrlEncoder.encodeURIComponent(SORT), k -> new ArrayList<>(1));
        values.add(formatSort(fieldName, order));
        return this;
    }

    public ApiQueryParam withView(String viewId) {
        return withParam(VIEW_ID, viewId);
    }

    public ApiQueryParam withRecordIds(List recordIds) {
        return withParam(RECORD_IDS, recordIds);
    }

    public ApiQueryParam withFields(List fieldNames) {
        return withParam(FIELDS, fieldNames);
    }

    public ApiQueryParam withFilter(String formula) {
        return withParam(FILTER_BY_FORMULA, UrlEncoder.encodeURIComponent(formula));
    }

    public ApiQueryParam withMaxRecords(int maxRecords) {
        return withParam(MAX_RECORDS, Integer.toString(maxRecords));
    }

    public ApiQueryParam withCellFormat(CellFormat cellFormat) {
        return withParam(CELL_FORMAT, cellFormat.name().toLowerCase());
    }

    public ApiQueryParam withFieldKey(FieldKey fieldKey) {
        return withParam(FIELD_KEY, fieldKey.name().toLowerCase());
    }

    public ApiQueryParam withParam(String key, String value) {
        if (value != null && !value.isEmpty()) {
            add(key, value);
        }
        return this;
    }

    public ApiQueryParam withParam(String key, List value) {
        if (value != null && !value.isEmpty()) {
            addAll(key, value);
        }
        return this;
    }

    private void addAll(String key, List values) {
        List currentValues = this.computeIfAbsent(key, k -> new ArrayList<>(1));
        currentValues.addAll(values);
    }

    private void add(String key, String value) {
        List values = this.computeIfAbsent(key, k -> new ArrayList<>(1));
        values.add(value);
    }

    private String formatSort(String fieldName, Order order) {
        Map sortMap = new HashMap<>(2);
        sortMap.put("field", fieldName);
        sortMap.put("order", order.name().toLowerCase());
        try {
            return UrlEncoder.encodeURIComponent(new ObjectMapper().writeValueAsString(sortMap));
        }
        catch (JsonProcessingException e) {
            throw new IllegalArgumentException("can't format sort parameter", e);
        }
    }

    public Map toMap() {
        Map queryMap = new HashMap<>();
        for (Entry> entry : this.entrySet()) {
            if (entry.getValue().size() == 1) {
                queryMap.put(entry.getKey(), entry.getValue().get(0));
            }
            else if (entry.getValue().size() > 1) {
                for (int i = 0; i < entry.getValue().size(); i++) {
                    queryMap.put(entry.getKey() + "." + i, entry.getValue().get(i));
                }
            }
        }
        return queryMap;
    }
}