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

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

Removed all occurrences of classes explicitly importing other classes in the same package.

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