1 /* Version 1.0 based on Apache Software License 1.1
2 *
3 * Copyright (c) 2003 Piotr Maj and DBMonster developers. All rights
4 * reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met:
9 *
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 *
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * 3. The end-user documentation included with the redistribution, if any,
18 * must include the following acknowledgment:
19 *
20 * "This product includes software developed by DBMonster developers
21 * (http://dbmonster.kernelpanic.pl/)."
22 *
23 * Alternately, this acknowledgment may appear in the software itself,
24 * if and wherever such third-party acknowledgments normally appear.
25 *
26 * 4. The name "DBMonster" must not be used to endorse or promote products
27 * derived from this software without prior written permission. For
28 * written permission, please contact pm@jcake.com.
29 *
30 * 5. Products derived from this software may not be called "DBMonster",
31 * nor may "DBMonster" appear in their name, without prior written
32 * permission of Piotr Maj.
33 *
34 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
35 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
36 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
37 * IN NO EVENT SHALL THE DBMONSTER DEVELOPERS BE LIABLE FOR ANY DIRECT,
38 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
39 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
40 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
42 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
43 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
44 * POSSIBILITY OF SUCH DAMAGE.
45 */
46
47 package pl.kernelpanic.dbmonster.generator;
48
49 import java.util.List;
50
51 import pl.kernelpanic.dbmonster.schema.Key;
52
53 /***
54 * The interface which every key generator must implement.
55 *
56 * @author Piotr Maj <pm@jcake.com>
57 *
58 * @version $Id: KeyGenerator.java,v 1.2 2004/06/14 19:26:16 majek Exp $
59 */
60 public interface KeyGenerator {
61
62 /***
63 * Sets the key.
64 *
65 * @param key a key
66 */
67 void setKey(Key key);
68
69 /***
70 * Returns the key
71 */
72 Key getKey();
73
74 /***
75 * Returns columns.
76 *
77 * @return a list of columns
78 */
79 List getColumns();
80
81 /***
82 * Generates a primary key.
83 *
84 * @return a list of generated <code>Column</code>s.
85 *
86 * @throws Exception if generation is not possible
87 */
88 List generate() throws Exception;
89 }