src/jdk.incubator.adba/share/classes/jdk/incubator/sql2/RowOperation.java
author lancea
Sat, 20 Oct 2018 08:17:38 -0400
branchJDK-8188051-branch
changeset 56997 c9cbac2979fb
parent 56797 fb523d4d9185
permissions -rw-r--r--
JDK-8188051-branch October 20 ABDA updates
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
56380
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
     1
/*
56797
fb523d4d9185 JDK-8188051-branch updates
lancea
parents: 56380
diff changeset
     2
 * Copyright (c)  2017, 2018, Oracle and/or its affiliates. All rights reserved.
56380
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
     4
 *
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    10
 *
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    15
 * accompanied this code).
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    16
 *
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    20
 *
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    23
 * questions.
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    24
 */
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    25
package jdk.incubator.sql2;
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    26
56797
fb523d4d9185 JDK-8188051-branch updates
lancea
parents: 56380
diff changeset
    27
import java.util.function.BiConsumer;
56380
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    28
import java.util.function.Consumer;
56797
fb523d4d9185 JDK-8188051-branch updates
lancea
parents: 56380
diff changeset
    29
import java.util.function.Supplier;
56380
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    30
import java.util.stream.Collector;
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    31
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    32
/**
56997
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    33
 * A {@code RowOperation} is a database operation that returns a row sequence.
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    34
 *
56380
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    35
 * @param <T> the type of the result of this {@link Operation}
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    36
 */
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    37
public interface RowOperation<T> extends Operation<T> {
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    38
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    39
  /**
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    40
   * A hint to the implementation of how many rows to fetch in each database
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    41
   * access. Implementations are free to ignore it.
56997
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    42
   *
56380
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    43
   * @param rows suggested number of rows to fetch per access
56997
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    44
   * @return this {@code RowOperation}
56380
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    45
   * @throws IllegalArgumentException if row &lt; 1
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    46
   * @throws IllegalStateException if this method had been called previously or
56997
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    47
   * this {@link Operation} has been submitted.
56380
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    48
   */
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    49
  public RowOperation<T> fetchSize(long rows) throws IllegalArgumentException;
56997
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    50
56380
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    51
  /**
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    52
   * Provides a {@link Collector} to reduce the sequence of rows.The result of
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    53
   * the {@link Operation} is the result of calling finisher on the final
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    54
   * accumulated result. If the {@link Collector} is
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    55
   * {@link Collector.Characteristics#UNORDERED} rows may be accumulated out of
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    56
   * order. If the {@link Collector} is
56997
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    57
   * {@link Collector.Characteristics#CONCURRENT} then the sequence of rows may
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    58
   * be split into subsequences that are reduced separately and then combined.
56380
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    59
   *
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    60
   * @param <A> the type of the accumulator
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    61
   * @param <S> the type of the final result
56997
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    62
   * @param c the Collector. Not {@code null}.
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    63
   * @return This {@code RowOperation}
56380
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    64
   * @throws IllegalStateException if this method had been called previously or
56997
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    65
   * this {@link Operation} has been submitted.
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    66
   */
56797
fb523d4d9185 JDK-8188051-branch updates
lancea
parents: 56380
diff changeset
    67
  public <A, S extends T> RowOperation<T> collect(Collector<? super Result.RowColumn, A, S> c);
56997
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    68
56797
fb523d4d9185 JDK-8188051-branch updates
lancea
parents: 56380
diff changeset
    69
  /**
56997
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    70
   * Convenience method to collect the rows when the accumulated result is the
56797
fb523d4d9185 JDK-8188051-branch updates
lancea
parents: 56380
diff changeset
    71
   * final result.
56997
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    72
   *
56797
fb523d4d9185 JDK-8188051-branch updates
lancea
parents: 56380
diff changeset
    73
   * @param <S> the type of the accumulated result
fb523d4d9185 JDK-8188051-branch updates
lancea
parents: 56380
diff changeset
    74
   * @param supplier supplies the accumulated result
56997
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    75
   * @param accumulator accumulates each {@link Result.RowColumn} into the
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    76
   * accumulated result
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    77
   * @return this {@code RowOperation}
56797
fb523d4d9185 JDK-8188051-branch updates
lancea
parents: 56380
diff changeset
    78
   */
fb523d4d9185 JDK-8188051-branch updates
lancea
parents: 56380
diff changeset
    79
  public default <S extends T> RowOperation<T> collect(Supplier<S> supplier,
56997
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    80
                                                       BiConsumer<S, Result.RowColumn> accumulator) {
56797
fb523d4d9185 JDK-8188051-branch updates
lancea
parents: 56380
diff changeset
    81
    return collect(Collector.of(supplier, accumulator, (l, r) -> l));
fb523d4d9185 JDK-8188051-branch updates
lancea
parents: 56380
diff changeset
    82
  }
56380
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    83
56997
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    84
  /**
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    85
   * {@inheritDoc}
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    86
   *
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    87
   * @return this {@code RowOperation}
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    88
   */
56380
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    89
  @Override
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    90
  public RowOperation<T> onError(Consumer<Throwable> handler);
56997
c9cbac2979fb JDK-8188051-branch October 20 ABDA updates
lancea
parents: 56797
diff changeset
    91
56380
f06946e00a26 JDK-8188051-branch: add jdk.incubator.adba
lancea
parents:
diff changeset
    92
}