1 /*
2 * $Source: /usr/cvsroot/melati/poem/src/main/java/org/melati/poem/ExtraColumn.java,v $
3 * $Revision: 1.21 $
4 *
5 * Copyright (C) 2000 William Chesters
6 *
7 * Part of Melati (http://melati.org), a framework for the rapid
8 * development of clean, maintainable web applications.
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 * William Chesters <williamc At paneris.org>
42 * http://paneris.org/~williamc
43 * Obrechtstraat 114, 2517VX Den Haag, The Netherlands
44 */
45
46 package org.melati.poem;
47
48
49 /**
50 * A {@link Column} which exists in the dbms but is not defined in the
51 * DSD.
52 */
53 public class ExtraColumn extends Column {
54 private final int extrasIndex;
55
56 /**
57 * Constructor.
58 */
59 public ExtraColumn(Table table, String name, SQLPoemType type,
60 DefinitionSource definitionSource,
61 int extrasIndex) {
62 super(table, name, type, definitionSource);
63 this.extrasIndex = extrasIndex;
64 }
65
66 /**
67 * {@inheritDoc}
68 * @see org.melati.poem.Column#getRaw(org.melati.poem.Persistent)
69 */
70 public Object getRaw(Persistent g) throws AccessPoemException {
71 ((JdbcPersistent)g).readLock();
72 return getRaw_unsafe(g);
73 }
74
75 /**
76 * {@inheritDoc}
77 * @see org.melati.poem.Column#getRaw_unsafe(org.melati.poem.Persistent)
78 */
79 public Object getRaw_unsafe(Persistent g) {
80 return ((JdbcPersistent)g).extras()[extrasIndex];
81 }
82
83 /**
84 * {@inheritDoc}
85 * @see org.melati.poem.Column#setRaw(org.melati.poem.Persistent, java.lang.Object)
86 */
87 public void setRaw(Persistent g, Object raw)
88 throws AccessPoemException, ValidationPoemException {
89 getType().assertValidRaw(raw);
90 ((JdbcPersistent)g).writeLock();
91 setRaw_unsafe(g, raw);
92 }
93
94 /**
95 * {@inheritDoc}
96 * @see org.melati.poem.Column#setRaw_unsafe(org.melati.poem.Persistent, java.lang.Object)
97 */
98 public void setRaw_unsafe(Persistent g, Object raw) {
99 ((JdbcPersistent)g).extras()[extrasIndex] = raw;
100 }
101
102 /**
103 * {@inheritDoc}
104 * @see org.melati.poem.Column#getCooked(org.melati.poem.Persistent)
105 */
106 public Object getCooked(Persistent g)
107 throws AccessPoemException, PoemException {
108 // FIXME Revalidation
109 return getType().cookedOfRaw(getRaw(g));
110 }
111
112 /**
113 * {@inheritDoc}
114 * @see org.melati.poem.Column#setCooked(org.melati.poem.Persistent, java.lang.Object)
115 */
116 public void setCooked(Persistent g, Object cooked)
117 throws AccessPoemException, ValidationPoemException {
118 // FIXME Revalidation
119 getType().assertValidCooked(cooked);
120 setRaw(g, getType().rawOfCooked(cooked));
121 }
122
123 /**
124 * {@inheritDoc}
125 * @see org.melati.poem.Column#asField(org.melati.poem.Persistent)
126 */
127 public Field asField(Persistent g) {
128 try {
129 return new Field(getRaw(g), this);
130 }
131 catch (AccessPoemException accessException) {
132 return new Field(accessException, this);
133 }
134 }
135
136 /**
137 * Static factory.
138 * @param table
139 * @param columnInfo
140 * @param extrasIndex
141 * @param source
142 * @return a new ExtraColumn
143 */
144 public static Column from(Table table, ColumnInfo columnInfo,
145 int extrasIndex, DefinitionSource source) {
146 return new ExtraColumn(
147 table, columnInfo.getName(), columnInfo.getType(),
148 source, extrasIndex);
149 }
150 }