1 /*
2 * $Source$
3 * $Revision$
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 import java.util.Enumeration;
49 import org.melati.poem.util.IntegerEnumeration;
50
51 /**
52 * A data type used within the POEM {@link ColumnInfo} metadata.
53 * <p>
54 * Whether field can be searched upon.
55 */
56 public class SearchabilityPoemType extends IndexPoemType {
57
58 /**
59 * Constructor, non-nullable.
60 */
61 public SearchabilityPoemType() {
62 super(false);
63 }
64
65 /**
66 * {@inheritDoc}
67 * @see org.melati.poem.PoemType#possibleRaws()
68 */
69 public Enumeration<Integer> possibleRaws() {
70 return new IntegerEnumeration(0, Searchability.count());
71 }
72
73 protected void _assertValidCooked(Object cooked)
74 throws ValidationPoemException {
75 if (!(cooked instanceof Searchability))
76 throw new TypeMismatchPoemException(cooked, this);
77 }
78
79 protected Object _cookedOfRaw(Object raw) throws NoSuchRowPoemException {
80 return Searchability.forIndex(((Integer)raw).intValue());
81 }
82
83 protected Integer _rawOfCooked(Object cooked) {
84 return ((Searchability)cooked).getIndex();
85 }
86
87 protected String _stringOfCooked(Object cooked,
88 PoemLocale locale, int style)
89 throws PoemException {
90 return ((Searchability)cooked).getName();
91 }
92
93 protected boolean _canRepresent(SQLPoemType<?> other) {
94 return other instanceof SearchabilityPoemType;
95 }
96
97 protected void _saveColumnInfo(ColumnInfo columnInfo)
98 throws AccessPoemException {
99 columnInfo.setTypefactory(PoemTypeFactory.SEARCHABILITY);
100 }
101
102 /**
103 * {@inheritDoc}
104 * @see java.lang.Object#toString()
105 */
106 public String toString() {
107 return "searchability (" + super.toString() + ")";
108 }
109
110 /**
111 * {@inheritDoc}
112 * @see org.melati.poem.PoemType#toDsdType()
113 */
114 public String toDsdType() {
115 return "Searchability";
116 }
117 }