source: trunk/gli/src/org/greenstone/gatherer/cdm/LanguageManager.java@ 5931

Last change on this file since 5931 was 5902, checked in by jmt12, 21 years ago

Removing a language which just happens to be the default one also now clears the default value
  • Property svn:keywords set to Author Date Id Revision
File size: 17.9 KB
Line 
1/**
2 *#########################################################################
3 *
4 * A component of the Gatherer application, part of the Greenstone digital
5 * library suite from the New Zealand Digital Library Project at the
6 * University of Waikato, New Zealand.
7 *
8 * Author: John Thompson, Greenstone Digital Library, University of Waikato
9 *
10 * Copyright (C) 1999 New Zealand Digital Library Project
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 *########################################################################
26 */
27package org.greenstone.gatherer.cdm;
28
29/**************************************************************************************
30 * Written: 08/05/02
31 * Revised: 17/11/02 - Commented
32 * 07/07/03 - DOM support
33 **************************************************************************************/
34import java.awt.*;
35import java.awt.event.*;
36import java.io.*;
37import java.util.*;
38import javax.swing.*;
39import javax.swing.event.*;
40import org.greenstone.gatherer.Dictionary;
41import org.greenstone.gatherer.Gatherer;
42import org.greenstone.gatherer.cdm.CollectionConfiguration;
43import org.greenstone.gatherer.cdm.CollectionDesignManager;
44import org.greenstone.gatherer.cdm.Control;
45import org.greenstone.gatherer.cdm.DOMProxyListModel;
46import org.greenstone.gatherer.cdm.Language;
47import org.greenstone.gatherer.cdm.LanguageListCellRenderer;
48import org.w3c.dom.*;
49
50/** This class manages the language commands, remembering both a list of languages to build indexes in, plus the default language.
51 * @author John Thompson, Greenstone Digital Library, University of Waikato
52 * @version 2.3
53 */
54public class LanguageManager
55 extends DOMProxyListModel {
56
57 static final private Dimension LABEL_SIZE = new Dimension(125,25);
58
59 /** The visual controls for this manager. */
60 private Control controls = null;
61 /** A reference to this class as a model, for the inner controls class. */
62 private DOMProxyListModel model = null;
63 /** A hashtable of code->name mappings of known languages. */
64 private LinkedHashMap known_languages = null;
65 /** The default language object. */
66 private Language default_language = null;
67
68 /** Constructor. */
69 public LanguageManager(Element languages_element) {
70 super(languages_element, CollectionConfiguration.LANGUAGE_ELEMENT, new Language());
71
72 Gatherer.println("LanguageManager: " + getSize() + " languages parsed.");
73
74 this.model = this;
75 // Retrieve the default language
76 NodeList default_language_elements = CollectionDesignManager.collect_config.getDocumentElement().getElementsByTagName(CollectionConfiguration.LANGUAGE_DEFAULT_ELEMENT);
77 if(default_language_elements.getLength() > 0) {
78 default_language = new Language((Element)default_language_elements.item(0));
79 }
80 // Load a series of code->language mappings into known_languages, by reading from the 'languages.dat' file, which is essentially a subset of the ISO 639 Standard.
81 known_languages = new LinkedHashMap();
82 try {
83 File in_file = new File("languages.dat");
84 FileReader in_reader = new FileReader(in_file);
85 BufferedReader in = new BufferedReader(in_reader);
86 String entry = null;
87 while((entry = in.readLine()) != null) {
88 if(!entry.startsWith("#")) {
89 StringTokenizer tokenizer = new StringTokenizer(entry);
90 if(tokenizer.countTokens() >= 2) {
91 String name = tokenizer.nextToken();
92 String code = tokenizer.nextToken().toLowerCase();
93 known_languages.put(code, name);
94 }
95 }
96 }
97 in.close();
98 in_reader.close();
99 in = null;
100 in_reader = null;
101 in_file = null;
102 }
103 catch (Exception error) {
104 error.printStackTrace();
105 }
106 }
107
108 /** Method to add a new language.
109 * @param language The <strong>Language</strong> to add.
110 * @see org.greenstone.gatherer.Gatherer
111 * @see org.greenstone.gatherer.collection.CollectionManager
112 */
113 public void addLanguage(Language language) {
114 if(!contains(language)) {
115 Element element = language.getElement();
116 append(language);
117 Gatherer.c_man.configurationChanged();
118 }
119 }
120
121 public void destroy() {
122 if(controls != null) {
123 controls.destroy();
124 controls = null;
125 }
126 known_languages.clear();
127 known_languages = null;
128 }
129
130 /** Method to retrieve the control for this manager.
131 * @return the Control for editing the language partitions
132 */
133 public Control getControls() {
134 if(controls == null) {
135 // Build controls
136 controls = new LanguageControl();
137 }
138 return controls;
139 }
140
141 /** Method to retrieve the default language code.
142 * @return A <strong>Language</strong> containing a two letter code.
143 */
144 /* private Language getDefaultLanguage() {
145 // If no default is set...
146 if(default_language != null && default_language.isAssigned()) {
147 return default_language;
148 }
149 return null;
150 } */
151
152 /** Method to retrieve a certain language object by its code.
153 * @param code The two letter code of a language, as a <strong>String</strong>.
154 * @param assigned_only If <i>true</i> only those languages currently having indexes built for them are checked, otherwise the known languages buffer is checked.
155 * @return The <strong>Language</strong> that matches the given code, or <i>null</i> if no such language exists.
156 */
157 public Language getLanguage(String code) {
158 int size = getSize();
159 for(int i = 0; i < size; i++) {
160 Language language = (Language) getElementAt(i);
161 if(language.getCode().equals(code)) {
162 return language;
163 }
164 }
165 return null;
166 }
167
168 public ArrayList getLanguages() {
169 return children();
170 }
171
172 /** Method to return a list of the known language codes.
173 * @return an ArrayList containing the series of known language codes as per the languages.dat file
174 */
175 public ArrayList getLanguageCodes() {
176 return new ArrayList(known_languages.keySet());
177 }
178
179 public String getLanguageName(String code) {
180 return (String) known_languages.get(code);
181 }
182
183 /** Method to remove a certain language.
184 * @param language The <strong>Language</strong> to remove.
185 * @see org.greenstone.gatherer.Gatherer
186 * @see org.greenstone.gatherer.collection.CollectionManager
187 */
188 public void removeLanguage(Language language) {
189 remove(language);
190 if(default_language != null && default_language.equals(language)) {
191 default_language = null;
192 ((LanguageControl)controls).clearDefaultLanguage();
193 }
194 Gatherer.c_man.configurationChanged();
195 }
196
197 /** Method to set the default language.
198 * @param language The <strong>Language</strong> to use as a default, or <i>null</i> for no default.
199 * @see org.greenstone.gatherer.Gatherer
200 * @see org.greenstone.gatherer.collection.CollectionManager
201 */
202 public void setDefault(Language language) {
203 if(language != null) {
204 if(default_language == null) {
205 // Create the default index element, and place immediately after indexes element.
206 Element default_language_element = root.getOwnerDocument().createElement(CollectionConfiguration.LANGUAGE_DEFAULT_ELEMENT);
207 default_language = new Language(default_language_element);
208 Node target_node = CollectionConfiguration.findInsertionPoint(default_language_element);
209 if(target_node != null) {
210 root.getOwnerDocument().getDocumentElement().insertBefore(default_language_element, target_node);
211 }
212 else {
213 root.getOwnerDocument().getDocumentElement().appendChild(default_language_element);
214 }
215 }
216 default_language.setAssigned(true);
217 default_language.setCode(language.getCode());
218 }
219 else {
220 if(default_language != null) {
221 default_language.setAssigned(false);
222 }
223 }
224 Gatherer.c_man.configurationChanged();
225 }
226
227
228 /** This class represents the visual component of the Language Manager. */
229 private class LanguageControl
230 extends JPanel
231 implements Control {
232 /** The button to add a new language support. */
233 private JButton add_button = null;
234 /** The button to clear the current default language. */
235 private JButton clear_button = null;
236 /** The button to remove a supported language. */
237 private JButton remove_button = null;
238 /** The button to set the current language as the default one. */
239 private JButton set_button = null;
240 /** A combobox listing the available supported languages. */
241 private JComboBox selector_combobox = null;
242 /** A list of currently supported languages. */
243 private JList language_list = null;
244 /** A description of the language currently selected. */
245 private JTextArea description_textarea = null;
246 /** The text field showing the currently name of the default language. Non-editable. */
247 private JTextField default_language_field = null;
248 /** Constructor.
249 * @see org.greenstone.gatherer.cdm.LanguageManager.Control.AddListener
250 * @see org.greenstone.gatherer.cdm.LanguageManager.Control.ClearDefaultListener
251 * @see org.greenstone.gatherer.cdm.LanguageManager.Control.ListListener
252 * @see org.greenstone.gatherer.cdm.LanguageManager.Control.RemoveListener
253 * @see org.greenstone.gatherer.cdm.LanguageManager.Control.SelectorListener
254 * @see org.greenstone.gatherer.cdm.LanguageManager.Control.SetDefaultListener
255 * @see org.greenstone.gatherer.cdm.LanguageManager.Control.TranslateListener
256 */
257 public LanguageControl() {
258 super();
259 // Creation.
260 JPanel center_panel = new JPanel();
261
262 JLabel language_list_label = new JLabel();
263 Dictionary.registerText(language_list_label, "CDM.LanguageManager.Assigned_Languages");
264 language_list = new JList(model);
265
266 JPanel details_panel = new JPanel();
267
268 JPanel default_panel = new JPanel();
269
270 JLabel default_label = new JLabel();
271 default_label.setBorder(BorderFactory.createEmptyBorder(0,0,0,5));
272 default_label.setPreferredSize(LABEL_SIZE);
273 Dictionary.registerText(default_label, "CDM.LanguageManager.Default_Language");
274
275 if(default_language == null) {
276 default_language_field = new JTextField();
277 }
278 else {
279 default_language_field = new JTextField(default_language.toString());
280 }
281 default_language_field.setBackground(Gatherer.config.getColor("coloring.collection_tree_background", false));
282 default_language_field.setEditable(false);
283 JPanel control_panel = new JPanel();
284
285 JLabel selector_label = new JLabel();
286 selector_label.setPreferredSize(LABEL_SIZE);
287 Dictionary.registerText(selector_label, "CDM.LanguageManager.Selector");
288
289 selector_combobox = new JComboBox(getLanguageCodes().toArray());
290 selector_combobox.setBackground(Gatherer.config.getColor("coloring.collection_tree_background", false));
291 selector_combobox.setRenderer(new LanguageListCellRenderer());
292 Dictionary.registerTooltip(selector_combobox, "CDM.LanguageManager.Selector_Tooltip");
293
294 JPanel button_panel = new JPanel();
295
296 add_button = new JButton();
297 add_button.setMnemonic(KeyEvent.VK_A);
298 Dictionary.registerBoth(add_button, "CDM.LanguageManager.Add", "CDM.LanguageManager.Add_Tooltip");
299
300 remove_button = new JButton();
301 remove_button.setMnemonic(KeyEvent.VK_R);
302 remove_button.setEnabled(false);
303 Dictionary.registerBoth(remove_button, "CDM.LanguageManager.Remove", "CDM.LanguageManager.Remove_Tooltip");
304
305 clear_button = new JButton();
306 clear_button.setMnemonic(KeyEvent.VK_C);
307 // If there is a default language, then this is enabled
308 clear_button.setEnabled(default_language != null && default_language.isAssigned());
309 Dictionary.registerBoth(clear_button, "CDM.LanguageManager.Clear_Default", "CDM.LanguageManager.Clear_Default_Tooltip");
310
311 set_button = new JButton();
312 set_button.setMnemonic(KeyEvent.VK_S);
313 set_button.setEnabled(false);
314 Dictionary.registerBoth(set_button, "CDM.LanguageManager.Set_Default", "CDM.LanguageManager.Set_Default_Tooltip");
315
316 // Set up and connect listeners.
317 add_button.addActionListener(new AddListener());
318 clear_button.addActionListener(new ClearDefaultListener());
319 remove_button.addActionListener(new RemoveListener());
320 selector_combobox.addActionListener(new SelectorListener());
321 set_button.addActionListener(new SetDefaultListener());
322 language_list.addListSelectionListener(new ListListener());
323
324 // Layout components
325 default_panel.setBorder(BorderFactory.createCompoundBorder(BorderFactory.createRaisedBevelBorder(), BorderFactory.createEmptyBorder(2,0,2,2)));
326 default_panel.setLayout(new BorderLayout());
327 default_panel.add(default_label, BorderLayout.WEST);
328 default_panel.add(default_language_field, BorderLayout.CENTER);
329
330 control_panel.setBorder(BorderFactory.createEmptyBorder(5,0,0,0));
331 control_panel.setLayout(new BorderLayout());
332 control_panel.add(selector_label, BorderLayout.WEST);
333 control_panel.add(selector_combobox, BorderLayout.CENTER);
334
335 details_panel.setBorder(BorderFactory.createEmptyBorder(5,0,5,0));
336 details_panel.setLayout(new BorderLayout());
337 details_panel.add(default_panel, BorderLayout.CENTER);
338 details_panel.add(control_panel, BorderLayout.SOUTH);
339
340 center_panel.setLayout(new BorderLayout());
341 center_panel.add(language_list_label, BorderLayout.NORTH);
342 center_panel.add(new JScrollPane(language_list), BorderLayout.CENTER);
343 center_panel.add(details_panel, BorderLayout.SOUTH);
344
345 button_panel.setLayout(new GridLayout(2,2));
346 button_panel.add(add_button);
347 button_panel.add(remove_button);
348 button_panel.add(set_button);
349 button_panel.add(clear_button);
350
351 setBorder(BorderFactory.createEmptyBorder(5,5,5,5));
352 setLayout(new BorderLayout());
353 add(center_panel, BorderLayout.CENTER);
354 add(button_panel, BorderLayout.SOUTH);
355 }
356
357 public void clearDefaultLanguage() {
358 clear_button.doClick();
359 }
360
361 /** Destructor. */
362 public void destroy() {
363 }
364
365 public void gainFocus() {
366 }
367
368 public void loseFocus() {
369 }
370
371 /** Listens for actions apon the 'add' button in the LanguageManager controls, and if detected calls the add method of the manager with a newly created language. */
372 private class AddListener
373 implements ActionListener {
374 /** Add a new language support.
375 * @param event an ActionEvent
376 * @see org.greenstone.gatherer.cdm.Language
377 */
378 public void actionPerformed(ActionEvent event) {
379 String language_code = (String) selector_combobox.getSelectedItem();
380 if(language_code != null) {
381 addLanguage(new Language(language_code));
382 }
383 add_button.setEnabled(false);
384 }
385 }
386
387 /** Listens for actions apon the 'clear default' button in the LanguageManager controls, and if detected calls the setDefault method of the manager with <i>null</i>. */
388 private class ClearDefaultListener
389 implements ActionListener {
390 /** Clear the default index.
391 * @param event An <strong>ActionEvent</strong>.
392 */
393 public void actionPerformed(ActionEvent event) {
394 setDefault(null);
395 clear_button.setEnabled(false);
396 default_language_field.setText("");
397 }
398 }
399
400 /** Listens for actions apon the 'remove' button in the LanguageManager controls, and if detected calls the remove method of the manager with the language selected for removal. */
401 private class RemoveListener
402 implements ActionListener {
403 /** Remove the currently selected language, if any.
404 * @param event An <strong>ActionEvent</strong>.
405 * @see org.greenstone.gatherer.cdm.Language
406 */
407 public void actionPerformed(ActionEvent event) {
408 Language delete_me = (Language)language_list.getSelectedValue();
409 if(delete_me != null) {
410 removeLanguage(delete_me);
411 if(default_language != null && default_language.equals(delete_me)) {
412 setDefault(null);
413 clear_button.setEnabled(false);
414 default_language_field.setText("");
415 }
416 }
417 remove_button.setEnabled(false);
418 }
419 }
420
421 /** Listens for selections within the combobox on the LanguageManager controls, and if a change is detected enables, or disables, controls appropriately. */
422 private class SelectorListener
423 implements ActionListener {
424 /** Enable or disable controls depeding on selection.
425 * @param event An <strong>ActionEvent</strong>.
426 */
427 public void actionPerformed(ActionEvent event) {
428 if(selector_combobox.getSelectedItem() != null) {
429 add_button.setEnabled(true);
430 }
431 else {
432 add_button.setEnabled(false);
433 }
434 }
435 }
436
437 /** Listens for actions apon the 'set default' button in the LanguageManager controls, and if detected calls the <i>setDefault()</i> method of the manager with the language selected for default. */
438 private class SetDefaultListener
439 implements ActionListener {
440 /** Set the default index to the one currently selected, if any.
441 * @param event An <strong>ActionEvent</strong>.
442 * @see org.greenstone.gatherer.cdm.Language
443 */
444 public void actionPerformed(ActionEvent event) {
445 if(!language_list.isSelectionEmpty()) {
446 setDefault((Language)language_list.getSelectedValue());
447 clear_button.setEnabled(true);
448 default_language_field.setText(default_language.toString());
449 }
450 }
451 }
452
453 /** Listens for selections within the list on the LanguageManager controls, and if a change is detected enables, or disables, controls appropriately. */
454 private class ListListener
455 implements ListSelectionListener {
456 /** Enable or disable controls depending on the current list selection.
457 * @param event A <strong>ListSelectionEvent</strong>.
458 */
459 public void valueChanged(ListSelectionEvent event) {
460 if(language_list.isSelectionEmpty()) {
461 remove_button.setEnabled(false);
462 set_button.setEnabled(false);
463 }
464 else {
465 remove_button.setEnabled(true);
466 set_button.setEnabled(true);
467 }
468 }
469 }
470 }
471}
Note: See TracBrowser for help on using the repository browser.