io.inversion.Results Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of inversion-core-api Show documentation
Inversion Cloud API Engine
The newest version!
/*
 * Copyright (c) 2015-2019 Rocket Partners, LLC
 * https://github.com/inversion-api
 *
 * 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 io.inversion;

import io.inversion.query.Query;
import io.inversion.rql.Term;

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

/**
 * Results are returned by a Db and transformed by Actions into Response content.
 * 
 * Dbs are not responsible for mapping from column names to json names so a Results rows
 * and terms will use column names until they are potentially transformed by an Action.
 */
public final class Results> implements Iterable {
    public static String LAST_QUERY = null;
    /**
     * The RQL terms that will get the next page of results the DB things there are more results.
     * 

     * Dbs are not responsible for mapping from column names to json names so these terms will
     * have column names when initially returned from the Db.
     * 

     * Actions should map the keys to the corresponding json name property names before returning to the caller.
     */
    protected final List next = new ArrayList<>();
    /**
     * the query that produced these results.
     */
    protected Query query;
    /**
     * The data the query produced.
     * 

     * Dbs are not responsible for mapping from column names to json names so these maps will
     * have column names keys when initially returned from the Db.
     * 

     * Actions should map them to the corresponding json property names before returning to the caller.
     */
    protected List rows = new ArrayList<>();
    /**
     * The total number of rows (if known) in the Db that match the query, not the number of rows returned in this Results.
     * 
     * For paginated listings, foundRows generally be greater than rows.size()
     */
    protected int    foundRows  = -1;
    protected String debugQuery = null;
    protected String testQuery  = null;

    public Results(Query query) {
        this.query = query;
    }

    public Results(Query query, int foundRows, List rows) {
        this.query = query;
        this.foundRows = foundRows;
        this.rows = rows;
    }

    public Query getQuery() {
        return query;
    }

    public Results withQuery(Query query) {
        this.query = query;
        return this;
    }

    @Override
    public Iterator iterator() {
        return rows.iterator();
    }

    public int size() {
        return rows.size();
    }

    public M getRow(int index) {
        return rows.get(index);
    }

    public Results setRow(int index, M row) {
        rows.set(index, row);
        return this;
    }

    public List getRows() {
        return rows;
    }

    public Results withRows(List rows) {
        this.rows = rows;
        return this;
    }

    public Results withRow(M row) {
        rows.add(row);
        return this;
    }

    public List getNext() {
        return new ArrayList(next);
    }

    public Results withNext(Term next) {
        this.next.add(next);
        return this;
    }

    public Results withNext(List next) {
        if (next != null)
            this.next.addAll(next);
        return this;
    }

    public int getFoundRows() {
        return foundRows;
    }

    public Results withFoundRows(int foundRows) {
        this.foundRows = foundRows;
        return this;
    }

    public String getTestQuery() {
        return testQuery;
    }

    public Results withTestQuery(String testQuery) {
        LAST_QUERY = testQuery;
        this.testQuery = testQuery;
        return this;
    }

}