com.apitable.client.api.RecordApi Maven / Gradle / Ivy
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;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import com.apitable.client.api.exception.ApiException;
import com.apitable.client.api.http.AbstractApi;
import com.apitable.client.api.http.ApiHttpClient;
import com.apitable.client.api.model.ApiQueryParam;
import com.apitable.client.api.model.CreateRecordRequest;
import com.apitable.client.api.model.HttpResult;
import com.apitable.client.api.model.Pager;
import com.apitable.client.api.model.PagerInfo;
import com.apitable.client.api.model.Record;
import com.apitable.client.api.model.Records;
import com.apitable.client.api.model.UpdateRecordRequest;
import com.apitable.core.http.GenericTypeReference;
import com.apitable.core.http.HttpHeader;
import com.apitable.core.utils.CollectionUtil;
import com.apitable.core.utils.MapUtil;
import com.apitable.core.utils.StringUtil;
/**
* the api for operate records
*/
public class RecordApi extends AbstractApi {
private static final String PATH = "/datasheets/%s/records";
public RecordApi(ApiHttpClient apiHttpClient) {
super(apiHttpClient);
}
public Stream getRecordsAsStream(String datasheetId) throws ApiException {
return getRecords(datasheetId, getDefaultPerPage()).stream();
}
public List getRecords(String datasheetId, int page, int itemsPerPage) throws ApiException {
if (page < 0 || itemsPerPage < 0) {
throw new ApiException("page or itemsPerPage don't set right");
}
ApiQueryParam queryParam = new ApiQueryParam(page, itemsPerPage);
Map uriVariables = queryParam.toMap();
GenericTypeReference>> reference = new GenericTypeReference>>() {};
String uri = String.format(PATH, datasheetId) + MapUtil.extractKeyToVariables(uriVariables);
HttpResult> result = getDefaultHttpClient().get(uri, new HttpHeader(), reference, uriVariables);
return result.getData().getRecords();
}
public Pager getRecords(String datasheetId) throws ApiException {
return new Pager<>(this, String.format(PATH, datasheetId), getDefaultPerPage(), Record.class);
}
public Pager getRecords(String datasheetId, int itemsPerPage) throws ApiException {
return new Pager<>(this, String.format(PATH, datasheetId), itemsPerPage, Record.class);
}
public Pager getRecords(String datasheetId, ApiQueryParam queryParam) throws ApiException {
return new Pager<>(this, String.format(PATH, datasheetId), queryParam, Record.class);
}
public List addRecords(String datasheetId, CreateRecordRequest record) throws ApiException {
if (!StringUtil.hasText(datasheetId)) {
throw new ApiException("datasheet id must be not null");
}
if (record == null) {
return null;
}
if (record.getRecords() == null) {
return null;
}
if (record.getRecords().isEmpty()) {
return null;
}
if (record.getRecords().size() > 10) {
throw new ApiException("record only can add 10 every request");
}
HttpResult result = getDefaultHttpClient().post(String.format(PATH, datasheetId), new HttpHeader(), record, new GenericTypeReference>() {});
return result.getData().getRecords();
}
public List updateRecords(String datasheetId, UpdateRecordRequest record) throws ApiException {
if (!StringUtil.hasText(datasheetId)) {
throw new ApiException("datasheet id must be not null");
}
if (record == null) {
throw new RuntimeException("Record instance cannot be null.");
}
HttpResult result = getDefaultHttpClient().patch(String.format(PATH, datasheetId), new HttpHeader(), record, new GenericTypeReference>() {});
return result.getData().getRecords();
}
public void deleteRecord(String datasheetId, String recordId) throws ApiException {
deleteRecords(datasheetId, Collections.singletonList(recordId));
}
public void deleteRecords(String datasheetId, List recordIds) throws ApiException {
if (!StringUtil.hasText(datasheetId)) {
throw new ApiException("datasheet id must be not null");
}
if (recordIds == null) {
throw new ApiException("record id array must be not null");
}
if (recordIds.isEmpty()) {
throw new ApiException("record id array must be not empty");
}
if (recordIds.size() > 10) {
List> splitList = CollectionUtil.splitListParallel(recordIds, 10);
splitList.forEach(split -> deleteLimitSize(datasheetId, split));
}
else {
deleteLimitSize(datasheetId, recordIds);
}
}
public void deleteAllRecords(String datasheetId) throws ApiException {
Stream recordStream = getRecordsAsStream(datasheetId);
List recordIds = recordStream.map(Record::getRecordId).collect(Collectors.toList());
if (!recordIds.isEmpty()) {
deleteRecords(datasheetId, recordIds);
}
}
private void deleteLimitSize(String datasheetId, List recordIds) {
Map uriVariables = MapUtil.listToUriVariableMap("recordIds", recordIds);
String uri = String.format(PATH, datasheetId) + MapUtil.extractKeyToVariables(uriVariables);
getDefaultHttpClient().delete(uri, new HttpHeader(), Void.class, uriVariables);
}
}