Changeset 4932 for trunk/gli/src/org/greenstone/gatherer/cdm/CollectionMeta.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/CollectionMeta.java (modified) (4 diffs)

trunk/gli/src/org/greenstone/gatherer/cdm/CollectionMeta.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 @@
  *########################################################################
  */
-
- 
-
-
-
-
-/* GPL_HEADER */
 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:        /05/02
- * Revised:      22/08/02 Revamped, Optimized and Commented.
+ * Written:     
+ * Revised:     28/06/03 - DOM support
  **************************************************************************************/
+import org.greenstone.gatherer.Configuration;
+import org.greenstone.gatherer.Gatherer;
+import org.greenstone.gatherer.cdm.CollectionConfiguration;
+import org.greenstone.gatherer.cdm.CollectionDesignManager;
+import org.greenstone.gatherer.cdm.DOMProxyListEntry;
 import org.greenstone.gatherer.cdm.Index;
-import org.greenstone.gatherer.cdm.Language;
+import org.greenstone.gatherer.msm.MSMUtils;
+import org.greenstone.gatherer.util.StaticStrings;
 import org.greenstone.gatherer.util.Utility;
+import org.w3c.dom.*;
 /** This class encapsulates a single collection level metadata assignment, which constitutes a name, language and value.
  * @author John Thompson, Greenstone Digital Library, University of Waikato
- * @version 2.3
+ * @version 2.4
  */
 public class CollectionMeta
-    implements Comparable {
-    /** A reference to the collection design manager for access to the language manager. */
-    private CollectionDesignManager manager = null;
-    /** The language of this metadata. Should be a two letter code. */
-    private Language language = null;
-    /** The name of the thing this metadata is assigned to, which may also refer to an Index or a Partition. */
-    private Object name = null;
-    /** The value of this metadata. */
-    private String value = null;
+    implements DOMProxyListEntry {
+    private Element element;
+    private String text;
+
     /** Constructor.
-     * @param name The object the metadata is assigned to as an <strong>Object</strong>.
-     * @param language The language of the metadata as a <strong>Language</strong>. Should be a two letter code.
-     * @param value The value of this metadata, as a <strong>String</strong>.
-      */
-    public CollectionMeta(CollectionDesignManager manager, Object name, Language language, String value) {
-    this.language = language;
-    this.manager = manager;
-    this.name = name;
-    this.value = value;
+     * @param element the Element from which we will determine metadata details
+     */
+    public CollectionMeta(Element element) {
+    this.element = element;
     }
+
+    /** Constructor to create a new piece of metadata given its name. */
+    public CollectionMeta(String name) {
+    element = CollectionDesignManager.collect_config.document.createElement(StaticStrings.COLLECTIONMETADATA_ELEMENT);
+    element.setAttribute(StaticStrings.NAME_ATTRIBUTE, name);
+    element.setAttribute(StaticStrings.LANGUAGE_ATTRIBUTE, Gatherer.config.interface_language);
+    }
+
+    /** Constructor to create a new piece of metadata given its name. */
+    public CollectionMeta(String name, String language) {
+    element = CollectionDesignManager.collect_config.document.createElement(StaticStrings.COLLECTIONMETADATA_ELEMENT);
+    element.setAttribute(StaticStrings.NAME_ATTRIBUTE, name);
+    element.setAttribute(StaticStrings.LANGUAGE_ATTRIBUTE, language);
+    }
+
     /** Method to compare two collection metadata objects to calculate their respective ordering.
-      * @param object The other metadata to compare to, as an <strong>Object</strong>.
-      * @return An <i>int</i> which is less than 0 if this object proceeds the given object, 0 if they are equal and greater than 0 otherwise.
-      * @see org.greenstone.gatherer.cdm.Language
-      */
+     * @param object the other metadata to compare to, as an Object
+     * @return an int which is less than 0 if this object proceeds the given object, 0 if they are equal and greater than 0 otherwise.
+     * @see org.greenstone.gatherer.cdm.Language
+     */
     public int compareTo(Object object) {
-    if(object instanceof CollectionMeta) {
-        CollectionMeta metadata = (CollectionMeta) object;
-        int result = name.toString().compareTo(metadata.getName().toString());
-        if(result == 0) {
-        Language other_language = metadata.getLanguage();
-        if(language != null && other_language != null) {
-            result = language.compareTo(metadata.getLanguage());
-            if(result == 0) {
-            return value.compareTo(metadata.getValue());
-            }
-        }
-        else if(language != null) {
-            return -1;
-        }
-        else if(other_language != null) {
-            return 1;
-        }
-        }
-        return result;
-    }
     return toString().compareTo(object.toString());
     }
+
+    /** Factory constructor. */
+    public DOMProxyListEntry create(Element element) {
+    return new CollectionMeta(element);
+    }
+
     /** Method to compare two collection metadata objects for equality.
-      * @param object The other metadata to compare to, as an <strong>Object</strong>.
-      * @return A <i>boolean</i> value of <i>true</i> if the object are equal, <i>false</i> otherwise.
-      */
+     * @param object The other metadata to compare to, as an <strong>Object</strong>.
+     * @return A <i>boolean</i> value of <i>true</i> if the object are equal, <i>false</i> otherwise.
+     */
     public boolean equals(Object object) {
-    if(compareTo(object) == 0) {
-        return true;
-    }
-    return false;
+    return (compareTo(object) == 0);
     }
+
+    public Element getElement() {
+    return element;
+    }
+
     /** Method to retrieve the value of language.
-     * @return The value of language as a <strong>Language</strong>.
+     * @return The value of language as a <strong>String</strong>.
      */
-    public Language getLanguage() {
-    return language;
+    public String getLanguage() {
+    // Retrieve the language string
+    return element.getAttribute(StaticStrings.LANGUAGE_ATTRIBUTE);
     }
+
     /** Method to retrieve the value of name.
-     * @return The value of name as an <strong>Object</strong>.
+     * @return 
      */
-    public Object getName() {
-    return name;
+    public String getName() {
+    return element.getAttribute(StaticStrings.NAME_ATTRIBUTE);
     }
     /** Method to retrieve the value of value (well great choice of name there).
-      * @return The value of value as a <strong>String</strong>.
-      */
+     * @return The value of value as a <strong>String</strong>.
+     */
     public String getValue() {
-    return value;
+    // We have to replace the string made of '\' 'n' with the '\n' character! Also watch for other greenstone magic
+    return Utility.decodeGreenstone(MSMUtils.getValue(element));
     }
-    /** Method to print out this class as it would appear within the collection configuration file.
-      * @return A <strong>String</strong> containing the text value of this class.
-      */
-    public String toString() {
-    String text = "collectionmeta ";
-    if(name instanceof Index) {
-        text = text + ".";
-        Index index = (Index)name;
-        text = text + index.toStringConfig() + " ";
+
+    public boolean isAssigned() {
+    return (element != null && !element.getAttribute(CollectionConfiguration.ASSIGNED_ATTRIBUTE).equals(CollectionConfiguration.FALSE_STR));
+    }
+
+    /** Determine if this metadata is one of the four special pieces of metadata.
+     * @return true if this metadata is special, false otherwise.
+     */
+    public boolean isSpecial() {
+    return (element != null && element.getAttribute(StaticStrings.SPECIAL_ATTRIBUTE).equals(StaticStrings.TRUE_STR));
+    }
+
+    public void setAssigned(boolean assigned) {
+    if(element != null) {
+        element.setAttribute(CollectionConfiguration.ASSIGNED_ATTRIBUTE, (assigned ? CollectionConfiguration.TRUE_STR : CollectionConfiguration.FALSE_STR));
     }
-    else if(name instanceof SubIndex) {
-        text = text + ".";
-        SubIndex index = (SubIndex)name;
-        text = text + index.toString() + " ";
-    }
-    else {
-        text = text + name.toString() + " ";
-    }
-    if(language != null && manager.languages.size() > 0 && !manager.languages.isDefaultLanguage(language)) {
-        text = text + "[l=" + language.getCode() + "] ";
-    }
-    text = text + "\"" + Utility.encodeGreenstone(value) + "\"\n";
-    return text;
     }
-    /** Used to update the contents of this collection level metadata to the given 'new' values.
-      * @param name The new name of the metadata, as a <strong>Object</strong>.
-      * @param language The new <strong>Language</strong> of the metadata.
-      * @param value And the value the metadata is assigned, as a <strong>String</strong>.
-      */
-    public void update(Object name, Language language, String value) {
-    this.name = name;
-    this.language = language;
-    this.value = value;
+
+    public void setElement(Element element) {
+    this.element = element;
+    text = null;
     }
 
@@ -174 +144 @@
      */
     public void setValue(String value) {
-    this.value = value;
+    MSMUtils.setValue(element, Utility.encodeGreenstone(value));
+    text = null; // Reset text
     }
 
-    /** Ensure this is a valid metadata entry by checking that the value is non-null and non-zero length (after having removed whitespace).
-     * @return <i>true</i> if this metadata has a valid value and should be added to the config, <i>false</i> otherwise.
-     */
-    public boolean valid() {
-    return(value != null && value.trim().length() > 0);
+    /** Method to print out this class as it would appear within the collection configuration file.
+      * @return A <strong>String</strong> containing the text value of this class.
+      */
+    public String toString() {
+    if(text == null) {
+        text = CollectionConfiguration.toString(element, true);
+    }
+    return text;
     }
 }