Changeset 4932 for trunk/gli/src/org/greenstone/gatherer/cdm/Language.java

Timestamp:

2003-07-15T13:55:22+12:00 (21 years ago)

Author:

jmt12

Message:

Major CDM rewrite so it uses DOM.

File:

• trunk/gli/src/org/greenstone/gatherer/cdm/Language.java (modified) (4 diffs)

trunk/gli/src/org/greenstone/gatherer/cdm/Language.java

@@ -6 +6 @@
  * University of Waikato, New Zealand.
  *
- * <BR><BR>
- *
  * Author: John Thompson, Greenstone Digital Library, University of Waikato
  *
- * <BR><BR>
- *
  * Copyright (C) 1999 New Zealand Digital Library Project
- *
- * <BR><BR>
  *
  * This program is free software; you can redistribute it and/or modify
@@ -21 +15 @@
  * (at your option) any later version.
  *
- * <BR><BR>
- *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- *
- * <BR><BR>
  *
  * You should have received a copy of the GNU General Public License
@@ -35 +25 @@
  *########################################################################
  */
-
- 
-
-
-
-
 package org.greenstone.gatherer.cdm;
 /**************************************************************************************
- * Title:        Gatherer
- * Description:  The Gatherer: a tool for gathering and enriching a digital collection.
- * Copyright:    Copyright (c) 2001
- * Company:      The University of Waikato
  * Written:      08/05/02
  * Revised:      17/11/02 - Commented
+ *               07/07/03 - DOM support
  **************************************************************************************/
-
+import org.greenstone.gatherer.cdm.CollectionConfiguration;
+import org.greenstone.gatherer.cdm.CollectionDesignManager;
+import org.greenstone.gatherer.cdm.DOMProxyListEntry;
+import org.greenstone.gatherer.msm.MSMUtils;
+import org.w3c.dom.*;
 /** A pretty unexciting extension of a two character string, in that it has a field which details if its the default language.
 * @author John Thompson, Greenstone Digital Library, University of Waikato
@@ -56 +41 @@
 */
 public class Language
-    implements Comparable {
-    /** Is this language the default one. */
-    private boolean default_language = false;
+    implements Comparable, DOMProxyListEntry {
+    /** The Element this language entry is based upon. */
+    private Element element = null;
+    /** The two character code for this language. */
+    private String code = null;
     /** The name of this language. */
     private String name = null;
-    /** The two character code for this language. */
-    private String value = null;
-    /** Constructor.
-     * @param value A <strong>String</strong> representing the code for this language.
-     * @param name A <strong>String</strong> representing the name of this language.
-     * @param default_language A <i>boolean</i> which is <i>true</i> if this language is the default one.
-      */
-    public Language(String value, String name, boolean default_language) {
-    this.default_language = default_language;
-    this.name = name;
-    this.value = value.substring(0, 2);
+ 
+    public Language() {
     }
-    /** Copy constructor.
-      * @param language The <strong>Language</strong> we want to copy.
-      */
-    public Language(Language language) {
-    this.default_language = language.isDefault();
-    this.name = language.toString();
-    this.value = language.getCode();
+
+    public Language(Element element) {
+    this.element = element;
     }
+
+    /** Constructor for a brand new language. */
+    public Language(String code) {
+    this.code = code;
+    // Create the new element
+    element = CollectionDesignManager.collect_config.document.createElement(CollectionConfiguration.LANGUAGE_ELEMENT);
+    element.setAttribute(CollectionConfiguration.NAME_ATTRIBUTE, code);
+    element.setAttribute(CollectionConfiguration.ASSIGNED_ATTRIBUTE, CollectionConfiguration.TRUE_STR);
+    }
+
     /** Method to compare two languages for ordering purposes.
-      * @param object The other language as an <strong>Object</strong>.
-      * @return An <i>int</i> which indicates order using the same values as in String.compareTo().
-      * @see java.lang.String#compareTo
-      */
+     * @param object the other language as an Object
+     * @return an int which indicates the order between this language and the given one: < 0, 0 or > 0 for before, equal to or after respectively
+     */
     public int compareTo(Object object) {
     return toString().compareTo(object.toString());
     }
+
+    public DOMProxyListEntry create(Element element) {
+    return new Language(element);
+    }
+
     /** Method to test for the equality of two languages.
-      * @param object The other language as an <strong>Object</strong>.
-      * @return <i>true</i> if the languages are equal, <i>false</i> otherwise.
-      */
+     * @param object The other language as an <strong>Object</strong>.
+     * @return <i>true</i> if the languages are equal, <i>false</i> otherwise.
+     */
     public boolean equals(Object object) {
-    if(compareTo(object) == 0) {
-        return true;
+    return (compareTo(object) == 0);
+    }
+
+    /** Method to retrieve the code of this language.
+     * @return A <strong>String</strong> representing the two letter code.
+     */
+    public String getCode() {
+    if(code == null && element != null) {
+        code = element.getAttribute(CollectionConfiguration.NAME_ATTRIBUTE);
     }
-    return false;
+    return code;
     }
-    /** Method to retrieve the code of this language.
-      * @return A <strong>String</strong> representing the two letter code.
-      */
-    public String getCode() {
-    return value;
+
+    public Element getElement() {
+    return element;
     }
-    /** Method to determine if this language is the default one.
-      * @return A <i>boolean</i> which is <i>true</i> if this language is the default one.
-      */
-    public boolean isDefault() {
-    return default_language;
+
+    public String getName() {
+    if(name == null) {
+        String code = getCode();
+        name = CollectionDesignManager.language_manager.getLanguageName(code);
+    }
+    return name;
     }
-    /** Method to set the value of default.
-      * @param value The new value of default as a <i>boolean</i>.
-      */
-    public void setDefault(boolean value) {
-    this.default_language = default_language;
+
+    public boolean isAssigned() {
+    return (element != null && element.getAttribute(CollectionConfiguration.ASSIGNED_ATTRIBUTE).equals(CollectionConfiguration.TRUE_STR));
     }
+
+    public void setAssigned(boolean value) {
+    if(element != null) {
+        element.setAttribute(CollectionConfiguration.ASSIGNED_ATTRIBUTE, (value ? CollectionConfiguration.TRUE_STR : CollectionConfiguration.FALSE_STR));
+    }
+    }
+
+    public void setCode(String new_code) {
+    code = new_code;
+    // Set element
+    if(element != null) {
+        element.setAttribute(CollectionConfiguration.NAME_ATTRIBUTE, new_code);
+    }
+    // Reset name
+    name = null;
+    }
+
+    public void setElement(Element new_element) {
+    element = new_element;
+    code = null;
+    name = null;
+    }
+
     /** Method to display the language code.
-      * @return A <strong>String</strong> representing the language code.
-      */
+     * @return A <strong>String</strong> representing the language code.
+     */
     public String toString() {
-    return name;
+    return getName();
     }
 }