1/*
2 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25package java.sql;
26
27/**
28 * A builder created from a {@code DataSource}  or {@code XADataSource} object,
29 * used to create a {@link ShardingKey} with sub-keys of supported data types.
30 * Implementations must
31 * support JDBCType.VARCHAR and  may also support additional data types.
32 * <p>
33 * The following example illustrates the use of {@code ShardingKeyBuilder} to
34 * create a {@link ShardingKey}:
35 * <pre>
36 * {@code
37 *
38 *     DataSource ds = new MyDataSource();
39 *     ShardingKey shardingKey = ds.createShardingKeyBuilder()
40 *                           .subkey("abc", JDBCType.VARCHAR)
41 *                           .subkey(94002, JDBCType.INTEGER)
42 *                           .build();
43 * }
44 * </pre>
45 *
46 * @since 9
47 */
48public interface ShardingKeyBuilder {
49
50    /**
51     * This method will be called to add a subkey into a Sharding Key object being
52     * built. The order in which subkey method is called is important as it
53     * indicates the order of placement of the subkey within the Sharding Key.
54     *
55     * @param subkey contains the object that needs to be part of shard sub key
56     * @param subkeyType sub-key data type of type java.sql.SQLType
57     * @return this builder object
58     */
59    ShardingKeyBuilder subkey(Object subkey, SQLType subkeyType);
60
61    /**
62     * Returns an instance of the object defined by this builder.
63     *
64     * @return The built object
65     * @throws java.sql.SQLException If an error occurs building the object
66     */
67    ShardingKey build() throws SQLException;
68}
69