oracle.nosql.driver.ops.PrepareResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nosqldriver Show documentation

Java examples for Oracle NoSQL Database

There is a newer version: 5.4.16

/*-
 * Copyright (c) 2011, 2020 Oracle and/or its affiliates.  All rights reserved.
 *
 * Licensed under the Universal Permissive License v 1.0 as shown at
 *  https://oss.oracle.com/licenses/upl/
 */

package oracle.nosql.driver.ops;

import oracle.nosql.driver.Consistency;
import oracle.nosql.driver.NoSQLHandle;

/**
 * The result of a prepare operation. The returned
 * {@link PreparedStatement} can be re-used for query execution using
 * {@link QueryRequest#setPreparedStatement}.
 *
 * @see NoSQLHandle#prepare
 */
public class PrepareResult extends Result {

    private PreparedStatement preparedStatement;

    public PrepareResult() {}

    /**
     * Returns the value of the prepared statement
     *
     * @return the prepared statement
     */
    public PreparedStatement getPreparedStatement() {
        return preparedStatement;
    }

    /**
     * @hidden
     * @param stmt the prepared statement
     * @return this
     */
    public PrepareResult setPreparedStatement(PreparedStatement stmt) {

        this.preparedStatement = stmt;
        return this;
    }

    /* from Result */

    /**
     * Returns the read throughput consumed by this operation, in KBytes.
     * This is the actual amount of data read by the operation. The number
     * of read units consumed is returned by {@link #getReadUnits} which may
     * be a larger number if the operation used {@link Consistency#ABSOLUTE}
     *
     * @return the read KBytes consumed
     */
    public int getReadKB() {
        return super.getReadKBInternal();
    }

    /**
     * Returns the write throughput consumed by this operation, in KBytes.
     *
     * @return the write KBytes consumed
     */
    public int getWriteKB() {
        return super.getWriteKBInternal();
    }

    /**
     * Returns the read throughput consumed by this operation, in read units.
     * This number may be larger than that returned by {@link #getReadKB} if
     * the operation used {@link Consistency#ABSOLUTE}
     *
     * @return the read units consumed
     */
    public int getReadUnits() {
        return super.getReadUnitsInternal();
    }

    /**
     * Returns the write throughput consumed by this operation, in write
     * units.
     *
     * @return the write units consumed
     */
    public int getWriteUnits() {
        return super.getWriteUnitsInternal();
    }
}