jdk/src/java.sql.rowset/share/classes/javax/sql/rowset/RowSetFactory.java
author martin
Wed, 02 Sep 2015 14:11:50 -0700
changeset 32427 c22b7e41adf3
parent 25859 3317bb8137f4
permissions -rw-r--r--
8134984: Text files should end in exactly one newline Summary: automated fixup of newlines at end-of-file via the usual perl one-liner Reviewed-by: chegar, sherman
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
6529
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
     1
/*
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
     2
 * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
     4
 *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    10
 *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    15
 * accompanied this code).
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    16
 *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    20
 *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    23
 * questions.
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    24
 */
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    25
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    26
package javax.sql.rowset;
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    27
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    28
import java.sql.SQLException;
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    29
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    30
/**
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    31
 * An interface that defines the implementation of a factory that is used
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    32
 * to obtain different types of {@code RowSet} implementations.
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    33
 *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    34
 * @author Lance Andersen
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    35
 * @since 1.7
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    36
 */
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    37
public interface RowSetFactory{
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    38
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    39
    /**
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    40
     * <p>Creates a new instance of a CachedRowSet.</p>
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    41
     *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    42
     * @return A new instance of a CachedRowSet.
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    43
     *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    44
     * @throws SQLException if a CachedRowSet cannot
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    45
     *   be created.
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    46
     *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    47
     * @since 1.7
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    48
     */
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    49
    public CachedRowSet createCachedRowSet() throws SQLException;
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    50
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    51
    /**
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    52
     * <p>Creates a new instance of a FilteredRowSet.</p>
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    53
     *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    54
     * @return A new instance of a FilteredRowSet.
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    55
     *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    56
     * @throws SQLException if a FilteredRowSet cannot
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    57
     *   be created.
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    58
     *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    59
     * @since 1.7
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    60
     */
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    61
    public FilteredRowSet createFilteredRowSet() throws SQLException;
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    62
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    63
    /**
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    64
     * <p>Creates a new instance of a JdbcRowSet.</p>
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    65
     *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    66
     * @return A new instance of a JdbcRowSet.
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    67
     *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    68
     * @throws SQLException if a JdbcRowSet cannot
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    69
     *   be created.
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    70
     *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    71
     * @since 1.7
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    72
     */
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    73
    public  JdbcRowSet createJdbcRowSet() throws SQLException;
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    74
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    75
    /**
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    76
     * <p>Creates a new instance of a JoinRowSet.</p>
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    77
     *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    78
     * @return A new instance of a JoinRowSet.
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    79
     *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    80
     * @throws SQLException if a JoinRowSet cannot
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    81
     *   be created.
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    82
     *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    83
     * @since 1.7
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    84
     */
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    85
    public  JoinRowSet createJoinRowSet() throws SQLException;
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    86
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    87
    /**
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    88
     * <p>Creates a new instance of a WebRowSet.</p>
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    89
     *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    90
     * @return A new instance of a WebRowSet.
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    91
     *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    92
     * @throws SQLException if a WebRowSet cannot
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    93
     *   be created.
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    94
     *
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    95
     * @since 1.7
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    96
     */
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    97
    public  WebRowSet createWebRowSet() throws SQLException;
bdf98f8db729 6843995: RowSet 1.1 updates
lancea
parents:
diff changeset
    98
32427
c22b7e41adf3 8134984: Text files should end in exactly one newline
martin
parents: 25859
diff changeset
    99
}