RequestResponseOK.java

/*******************************************************************************
 * Copyright French Prime minister Office/SGMAP/DINSIC/Vitam Program (2015-2019)
 *
 * contact.vitam@culture.gouv.fr
 *
 * This software is a computer program whose purpose is to implement a digital archiving back-office system managing
 * high volumetry securely and efficiently.
 *
 * This software is governed by the CeCILL 2.1 license under French law and abiding by the rules of distribution of free
 * software. You can use, modify and/ or redistribute the software under the terms of the CeCILL 2.1 license as
 * circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license,
 * users are provided only with a limited warranty and the software's author, the holder of the economic rights, and the
 * successive licensors have only limited liability.
 *
 * In this respect, the user's attention is drawn to the risks associated with loading, using, modifying and/or
 * developing or reproducing the software by the user in light of its specific status of free software, that may mean
 * that it is complicated to manipulate, and that also therefore means that it is reserved for developers and
 * experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the
 * software's suitability as regards their requirements in conditions enabling the security of their systems and/or data
 * to be ensured and, more generally, to use and operate it in the same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had knowledge of the CeCILL 2.1 license and that you
 * accept its terms.
 *******************************************************************************/
package fr.gouv.vitam.common.model;

import java.util.ArrayList;
import java.util.List;

import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.databind.JsonNode;

import fr.gouv.vitam.common.ParametersChecker;
import fr.gouv.vitam.common.exception.InvalidParseOperationException;
import fr.gouv.vitam.common.json.JsonHandler;


/**
 * Access RequestResponseOK class contains list of results<br>
 * default results : is an empty list (immutable)
 *
 */
public final class RequestResponseOK<T> extends RequestResponse<T> {
    @JsonProperty("$hits")
    private DatabaseCursor hits = new DatabaseCursor(0, 0, 0);
    @JsonProperty("$results")
    private final List<T> results = new ArrayList<T>();
    @JsonProperty("$context")
    private JsonNode query = JsonHandler.createObjectNode();

    /**
     * Empty RequestResponseOK constructor
     *
     **/
    public RequestResponseOK() {
        // Empty
    }

    /**
     * Add one result
     *
     * @param result
     * @return this
     */
    public RequestResponseOK<T> addResult(T result) {
        ParametersChecker.checkParameter("Result is a mandatory parameter", result);
        results.add(result);
        return this;
    }

    /**
     * Add list of results
     *
     * @param resultList the list of results
     * @return RequestResponseOK with mutable results list of String
     */
    @JsonSetter("$results")
    public RequestResponseOK<T> addAllResults(List<T> resultList) {
        ParametersChecker.checkParameter("Result list is a mandatory parameter", resultList);
        results.addAll(resultList);
        return this;
    }


    /**
     * @return the hits of RequestResponseOK object
     */
    public DatabaseCursor getHits() {
        return hits;
    }

    /**
     * @param hits as DatabaseCursor object
     * @return RequestReponseOK with the hits are setted
     */
    @JsonSetter("$hits")
    public RequestResponseOK setHits(DatabaseCursor hits) {
        if (hits != null) {
            this.hits = hits;
        }
        return this;
    }

    /**
     * @param total of units inserted/modified as integer
     * @param offset of unit in database as integer
     * @param limit of unit per response as integer
     * @return the RequestReponseOK with the hits are setted
     */
    @JsonSetter("$hits")
    public RequestResponseOK setHits(int total, int offset, int limit) {
        hits = new DatabaseCursor(total, offset, limit, total);
        return this;
    }

    /**
     * @param total of units inserted/modified as integer
     * @param offset of unit in database as integer
     * @param limit of unit per response as integer
     * @param size of unit per response
     * @return the RequestReponseOK with the hits are setted
     */
    @JsonSetter("$hits")
    public RequestResponseOK<T> setHits(int total, int offset, int limit, int size) {
        hits = new DatabaseCursor(total, offset, limit, size);
        return this;
    }

    /**
     * @return the result of RequestResponse as a list of String
     */
    @JsonGetter("$results")
    public List<T> getResults() {
        return results;
    }

    /**
     * @return the query as JsonNode of Response
     */
    public JsonNode getQuery() {
        return query;
    }

    /**
     * @param query
     * @return this
     */
    public RequestResponseOK<T> setQuery(JsonNode query) {
        if (query != null) {
            this.query = query;
        }
        return this;
    }

    /**
     * @param node
     * @return the corresponding VitamError
     * @throws InvalidParseOperationException
     */
    public static RequestResponseOK getFromJsonNode(JsonNode node) throws InvalidParseOperationException {
        return JsonHandler.getFromString(node.toString(), RequestResponseOK.class, JsonNode.class);
        //return JsonHandler.getFromJsonNode(node, RequestResponseOK.class);
    }

}