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

Last change on this file since 8231 was 8231, checked in by mdewsnip, 20 years ago

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