1 /*
2 * $Source$
3 * $Revision$
4 *
5 * Part of Melati (http://melati.org), a framework for the rapid
6 * development of clean, maintainable web applications.
7 *
8 * Copyright (C) 2001 Myles Chippendale
9 *
10 * Melati is free software; Permission is granted to copy, distribute
11 * and/or modify this software under the terms either:
12 *
13 * a) the GNU General Public License as published by the Free Software
14 * Foundation; either version 2 of the License, or (at your option)
15 * any later version,
16 *
17 * or
18 *
19 * b) any version of the Melati Software License, as published
20 * at http://melati.org
21 *
22 * You should have received a copy of the GNU General Public License and
23 * the Melati Software License along with this program;
24 * if not, write to the Free Software Foundation, Inc.,
25 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
26 * GNU General Public License and visit http://melati.org to obtain the
27 * Melati Software License.
28 *
29 * Feel free to contact the Developers of Melati (http://melati.org),
30 * if you would like to work out a different arrangement than the options
31 * outlined here. It is our intention to allow Melati to be used by as
32 * wide an audience as possible.
33 *
34 * This program is distributed in the hope that it will be useful,
35 * but WITHOUT ANY WARRANTY; without even the implied warranty of
36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
37 * GNU General Public License for more details.
38 *
39 * Contact details for copyright holder:
40 *
41 * Myles Chippendale <mylesc@paneris.org>
42 *
43 *
44 * ------
45 * Note
46 * ------
47 *
48 * I will assign copyright to PanEris (http://paneris.org) as soon as
49 * we have sorted out what sort of legal existence we need to have for
50 * that to make sense.
51 * In the meantime, if you want to use Melati on non-GPL terms,
52 * contact me!
53 */
54
55 package org.melati.poem.csv;
56
57 /**
58 * A bridging object which is both a column in a CSV file and
59 * a column in a POEM database.
60 * <p>
61 * A CSVColumn can be a primary key for this table, ie unique and
62 * used by other tables to refer to this record.
63 * <p>
64 * A CSVColumn can also be a foreign key into another {@link CSVTable}.
65 *
66 */
67 public class CSVColumn {
68
69 String poemName = null;
70 boolean isPrimaryKey = false;
71 CSVTable foreignTable = null;
72
73 /**
74 * Simplest case constructor.
75 *
76 * @param poemName the name of the POEM column this is to be mapped to.
77 */
78 public CSVColumn(String poemName) {
79 this.poemName = poemName;
80 }
81
82 /**
83 * Constructor for a key value into another table.
84 *
85 * @param poemName the name of the POEM column this is to be mapped to.
86 * @param foreignTable another CSVTable in which this value should be found.
87 */
88 public CSVColumn(String poemName, CSVTable foreignTable) {
89 this.poemName = poemName;
90 this.foreignTable = foreignTable;
91 }
92
93 /**
94 * Constructor for a key value into another table.
95 *
96 * @param poemName the name of the POEM column this is to be mapped to.
97 * @param isPrimaryKey flag to indicate this is the primary key column.
98 */
99 public CSVColumn(String poemName, boolean isPrimaryKey) {
100 this.poemName = poemName;
101 this.isPrimaryKey = isPrimaryKey;
102 }
103
104 }
105