com.arangodb.entity.CursorEntity Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Core module for ArangoDB Java Driver
There is a newer version: 7.16.0
/*
 * DISCLAIMER
 *
 * Copyright 2016 ArangoDB GmbH, Cologne, Germany
 *
 * 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.
 *
 * Copyright holder is ArangoDB GmbH, Cologne, Germany
 */

package com.arangodb.entity;

import com.arangodb.internal.serde.UserDataInside;

import java.util.Collection;
import java.util.Collections;
import java.util.List;

/**
 * @author Mark Vollmary
 */
public final class CursorEntity {
    private String id;
    private Integer count;
    private Boolean cached;
    private Boolean hasMore;
    @UserDataInside
    private List result;
    private Boolean potentialDirtyRead;
    private String nextBatchId;
    private final Extras extra = new Extras();

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    /**
     * @return the total number of result documents available (only available if the query was executed with the count
     * attribute set)
     */
    public Integer getCount() {
        return count;
    }

    /**
     * @return an optional object with extra information about the query result contained in its stats sub-attribute.
     * For data-modification queries, the extra.stats sub-attribute will contain the number of modified
     * documents and the number of documents that could not be modified due to an error (if ignoreErrors query
     * option is specified)
     */
    public Extras getExtra() {
        return extra;
    }

    /**
     * @return a boolean flag indicating whether the query result was served from the query cache or not. If the query
     * result is served from the query cache, the extra return attribute will not contain any stats
     * sub-attribute and no profile sub-attribute.
     */
    public Boolean getCached() {
        return cached;
    }

    /**
     * @return A boolean indicator whether there are more results available for the cursor on the server
     */
    public Boolean getHasMore() {
        return hasMore;
    }

    /**
     * @return a list of result documents (might be empty if query has no results)
     */
    public List getResult() {
        return result;
    }

    /**
     * @return true if the result is a potential dirty read
     * @since ArangoDB 3.10
     */
    public Boolean isPotentialDirtyRead() {
        return potentialDirtyRead;
    }

    public void setPotentialDirtyRead(final Boolean potentialDirtyRead) {
        this.potentialDirtyRead = potentialDirtyRead;
    }

    /**
     * @return The ID of the batch after the current one. The first batch has an ID of 1 and the value is incremented by
     * 1 with every batch. Only set if the allowRetry query option is enabled.
     * @since ArangoDB 3.11
     */
    public String getNextBatchId() {
        return nextBatchId;
    }

    public static final class Extras {
        private final Collection warnings = Collections.emptyList();
        private CursorStats stats;

        public CursorStats getStats() {
            return stats;
        }

        public Collection getWarnings() {
            return warnings;
        }
    }

}