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@paneris.org>
42 * http://paneris.org/~williamc
43 * Obrechtstraat 114, 2517VX Den Haag, The Netherlands
44 */
45
46 package org.melati.poem.prepro;
47
48 import java.io.StreamTokenizer;
49 import java.io.IOException;
50
51 /**
52 * A <tt>FieldQualifier</tt> which defines the type of
53 * <tt>Searchability</tt> a <tt>Field</tt> has.
54 *
55 */
56 public class SearchabilityFieldQualifier extends FieldQualifier {
57
58 private String searchability;
59
60 /**
61 * Constructor.
62 *
63 * @param tokens the <code>StreamTokenizer</code> to get tokens from
64 *
65 * @throws ParsingDSDException if an unexpected token is encountered
66 * @throws IOException if something goes wrong with the file system
67 */
68 public SearchabilityFieldQualifier(StreamTokenizer tokens)
69 throws ParsingDSDException, IOException {
70 DSD.expect(tokens, '=');
71 tokens.nextToken();
72 if (tokens.ttype != StreamTokenizer.TT_WORD)
73 throw new ParsingDSDException("<searchability level name>", tokens);
74
75 searchability = validSearchabilityNamed(tokens.sval);
76
77 tokens.nextToken();
78 }
79
80 /**
81 * Check Searchability name.
82 * @param sval Searchability name
83 * @return validated Searchability name
84 */
85 private String validSearchabilityNamed(String sval) {
86 if (sval.equals("primary") ||
87 sval.equals("yes") ||
88 sval.equals("no"))
89 return sval;
90 else
91 throw new ParsingDSDException("<searchability level name>: one of primary, yes or no", sval);
92 }
93
94 /**
95 * Update the model.
96 *
97 * @param field the {@link FieldDef} to update
98 *
99 * @throws IllegalityException if there is a semantic contractiction
100 */
101 public void apply(FieldDef field) throws IllegalityException {
102 field.searchability = searchability;
103 }
104 }