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

trunk/gli/src/org/greenstone/gatherer/cdm/Index.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:      03/05/02
- * Revised:      17/11/02
- **************************************************************************************/
-import java.util.Collections;
-import java.util.Comparator;
-import java.util.StringTokenizer;
-import java.util.Vector;
+
+import java.util.*;
+import org.greenstone.gatherer.Gatherer;
+import org.greenstone.gatherer.cdm.CollectionConfiguration;
+import org.greenstone.gatherer.cdm.CollectionDesignManager;
 import org.greenstone.gatherer.cdm.CollectionMeta;
+import org.greenstone.gatherer.cdm.DOMProxyListEntry;
+import org.greenstone.gatherer.msm.ElementWrapper;
 import org.greenstone.gatherer.msm.MSMUtils;
+import org.greenstone.gatherer.util.StaticStrings;
 import org.greenstone.gatherer.util.Utility;
-import org.w3c.dom.Element;
+import org.w3c.dom.*;
 /** This class encapsulates a single indexing pair.
  * @author John Thompson, Greenstone Digital Library, University of Waikato
- * @version 2.2
+ * @version 2.3d
  */
 public class Index
-    implements Comparable {
-    /** A refernce to the main manager for access to other sub-managers. */
-    private CollectionDesignManager manager = null;
-    /** The level of this index. */
-    private int level = 0;
-    /** The sources for data this index is built apon, which are either fully qualified metadata element names or 'text'. */
-    private Vector sources = null;
-    /** An element in the index level enumeration. */
-    static public final int DOCUMENT = 0;
-    /** An element in the index level enumeration. */
-    static public final int PARAGRAPH = 1;
-    /** An element in the index level enumeration. */
-    static public final int SECTION = 2;
+    implements Comparable, DOMProxyListEntry {
     /** An values of items in the index level enumeration. */
     static public final String LEVEL[] = {"document","paragraph","section"};
 
-    /** Constructor.
-     * @param level The level of this index as a <strong>String</string>.
-     * @param metadata The fully qualified name of the metadata this index is built on as a <strong>String</strong>, or <i>null</i> in which case the data defaults to "text".
-     */
-    public Index(int level, Vector sources, CollectionDesignManager manager) {
+    private ArrayList sources = null;
+    /** The level of this index (if old sckool MG). */
+    private int level = -1;
+    /** The element this index is based upon. */
+    private Element element = null;
+    /** The unique, if cryptic, identifier of an index. */
+    private String id = null;
+
+    /** Default constructor, which should only be used during DOMProxyListModel creation. */
+    public Index() {
+    }
+
+    /** Constructor. */
+    public Index(Element element) {
+    this.element = element;
+    }
+
+    /** Constructor for a newly assigned index. */
+    public Index(ArrayList sources) {
+    this.sources = sources;
+    // Create a new element
+    Document document = CollectionDesignManager.collect_config.document;
+    element = document.createElement(CollectionConfiguration.INDEX_ELEMENT);
+    // For each source add a content element
+    int size = sources.size();
+    for(int i = 0; i < size; i++) {
+        Element content_element = document.createElement(CollectionConfiguration.CONTENT_ELEMENT);
+        Object source_object = sources.get(i);
+        if(source_object instanceof ElementWrapper) {
+        content_element.setAttribute(CollectionConfiguration.NAME_ATTRIBUTE, ((ElementWrapper)source_object).getName());
+        }
+        else {
+        content_element.setAttribute(CollectionConfiguration.NAME_ATTRIBUTE, source_object.toString());
+        }
+        element.appendChild(content_element);
+        content_element = null;
+    }
+    document = null;
+    }
+
+    /** Constructor for a newly assigned index with specified level (old skool). */
+    public Index(int level, ArrayList sources) {
+    this(sources);
     this.level = level;
-    this.manager = manager;
-    this.sources = sources;
-    if(this.sources == null) {
-        this.sources = new Vector();
-        this.sources.add("text");
-    }
-    }
+    element.setAttribute(CollectionConfiguration.LEVEL_ATTRIBUTE, LEVEL[level]);
+    }
+
     /** Method to compare two indexes.
-      * @param object The other index as an <strong>Object</strong>.
-      * @return An <i>int</i> which indicates how the indexes compare.
-      * @see java.lang.String
-      */
+     * @param object The other index as an <strong>Object</strong>.
+     * @return An <i>int</i> which indicates how the indexes compare.
+     * @see java.lang.String
+     */
     public int compareTo(Object object) {
-    return toString(false).compareTo(object.toString());
-    }
+    return id.compareTo(((Index)object).getID());
+    }
+    
+    public DOMProxyListEntry create(Element element) {
+    return new Index(element);
+    }
+
     /** Method to test for the equality of two indexes.
-      * @param object The other index as an <strong>Object</strong>.
-      * @return A <i>boolean</i> which is <i>true</i> if the two indexes are equal, <i>false</i> otherwise.
-      */
+     * @param object The other index as an <strong>Object</strong>.
+     * @return A <i>boolean</i> which is <i>true</i> if the two indexes are equal, <i>false</i> otherwise.
+     */
     public boolean equals(Object object) {
-    if(compareTo(object) == 0) {
-        return true;
-    }
-    return false;
-    }
-    /** Method to get the data source of this index.
-      * @return A <strong>String</string> which is a comma separated list of either fully qualified names of an assigned metadata elements, or "text".
-      */
-    public String getData() {
-    String result = "";
-    Collections.sort(sources, new IndexComparator());
-    for(int i = 0; i < sources.size(); i++) {
-        result = result + sources.get(i).toString();
-        if(i < sources.size() - 1) {
-        result = result + ",";
-        }
-    }
-    return result;
-    }
-    /** Method to get the data source of this index.
-     * @return A <strong>String</string> which is a comma separated list of either fully qualified names of an assigned metadata elements, or "text".
-     * Note, greenstone extracted metadata do not have the ex. 
-     */
-    public String getDataConfig() {
-    String result = "";
-    Collections.sort(sources, new IndexComparator());
-    for(int i = 0; i < sources.size(); i++) {
-        String source = sources.get(i).toString();
-        if (source.startsWith(Utility.EXTRACTED_METADATA_NAMESPACE + MSMUtils.NS_SEP)) {
-        // remove the ex. bit
-        source = source.substring(source.indexOf(MSMUtils.NS_SEP)+1);
-        }
-        result = result + source;
-        if(i < sources.size() - 1) {
-        result = result + ",";
-        }
-    }
-    return result;
-    }
-    
+    return (compareTo(object) == 0);
+    }
+    
+    public Element getElement() {
+    return element;
+    }
+    
     /** Method to get the value of level.
-      * @return The value of level as a <strong>String</strong>.
-      */
+     * @return the level as a int
+     */
     public int getLevel() {
+    if(level == -1) {
+        String level_str = element.getAttribute(CollectionConfiguration.LEVEL_ATTRIBUTE);
+        for(int i = 0; level == -1 && i < LEVEL.length; i++) {
+        if(level_str.equals(LEVEL[i])) {
+            level = i;
+        }
+        }
+        level_str = null;
+    }
     return level;
     }
-    /** Method to get the value of metadata.
-      * @return The value of metadata as an <strong>Vector</strong>.
-      */
-    public Vector getMetadata() {
+
+    public String getID() {
+    if(id == null) {
+        StringBuffer id_buffer = new StringBuffer();
+        // Write level information, if any.
+        int level = getLevel();
+        if(0 <= level && level < 3) {
+        id_buffer.append(LEVEL[level]);
+        id_buffer.append(StaticStrings.COLON_CHARACTER);
+        }
+        // Write data information. Retrieve each of the content sources and add them in a comma separated list.
+        ArrayList sources = getSources();
+        int sources_size = sources.size();
+        for(int i = 0; i < sources_size; i++) {
+        Object source_object = sources.get(i);
+        if(source_object instanceof ElementWrapper) {
+            id_buffer.append(((ElementWrapper)source_object).getName());
+        }
+        else {
+            id_buffer.append(source_object.toString());
+        }
+        id_buffer.append(StaticStrings.COMMA_CHARACTER);
+        }
+        sources = null;
+        id = id_buffer.substring(0, id_buffer.length() - 1);
+    }
+    return id;
+    }
+
+    /** Retrieve the sources of this index.
+     * @return the sources as an ArrayList
+     */
+    public ArrayList getSources() {
+    if(sources == null) {
+        sources = new ArrayList();
+        NodeList content_elements = element.getElementsByTagName(CollectionConfiguration.CONTENT_ELEMENT);
+        int content_elements_length = content_elements.getLength();
+        for(int i = 0; i < content_elements_length; i++) {
+        Element content_element = (Element) content_elements.item(i);
+        sources.add(content_element.getAttribute(CollectionConfiguration.NAME_ATTRIBUTE));
+        }
+        content_elements = null;
+        Collections.sort(sources);
+    }
     return sources;
     }
-    /** Method to retrieve this indexes name.
-      * @return A <strong>String</strong>.
-      */
-    public String getName() {
-    if(manager != null) {
-        String name = LEVEL[level] + ":" + getData();
-        Language language = manager.languages.getDefaultLanguage();
-        CollectionMeta metadata = manager.collectionmetadatum.getMetadata(name, language, true);
-        if(metadata != null) {
-        return metadata.getValue();
-        }
-    }
-    return "";
-    
-    }
+
+    public boolean isAssigned() {
+    return (element != null && !element.getAttribute(CollectionConfiguration.ASSIGNED_ATTRIBUTE).equals(CollectionConfiguration.FALSE_STR));
+    }
+
+    public void setAssigned(boolean assigned) {
+    if(element != null) {
+        element.setAttribute(CollectionConfiguration.ASSIGNED_ATTRIBUTE, (assigned ? CollectionConfiguration.TRUE_STR : CollectionConfiguration.FALSE_STR));
+    }
+    }
+
+    public void setElement(Element element) {
+    this.element = element;
+    this.level = -1;
+    this.id = null;
+    this.sources = null;
+    }
+
+    /** Method to set the level of this index which can only be used for the default index. 
+     * @param level the new level as an int
+     */
+    public void setLevel(int new_level) {
+    if(element != null && element.getNodeName().equals(CollectionConfiguration.INDEX_DEFAULT_ELEMENT)) {
+        element.setAttribute(CollectionConfiguration.LEVEL_ATTRIBUTE, LEVEL[new_level]);
+        this.id = null; // Regenerate ID.
+        this.level = new_level;
+    }
+    else {
+        Gatherer.println("Error! Called setLevel() of index other than the default.");
+    }
+    }
+
+    /** Method to set the sources for this index which can only be used for the default index.
+     * @param sources an ArrayList of source names
+     */
+    public void setSources(ArrayList sources) {
+    if(element != null && element.getNodeName().equals(CollectionConfiguration.INDEX_DEFAULT_ELEMENT)) {
+        // Erase old sources
+        MSMUtils.clear(element);
+        // For each entry in the sources array add a new content element.
+        int size = sources.size();
+        for(int i = 0; i < size; i++) {
+        Element content_element = element.getOwnerDocument().createElement(CollectionConfiguration.CONTENT_ELEMENT);
+        content_element.setAttribute(CollectionConfiguration.NAME_ATTRIBUTE, (String) sources.get(i));
+        element.appendChild(content_element);
+        content_element = null;
+        }
+        this.id = null; // Regenerate ID.
+        this.sources = sources;
+    }
+    else {
+        Gatherer.println("Error! Called setSource() of index other than the default.");
+    }
+    }
+
     /** Method to turn this object into a string representation ready to be placed in the collection configuration file.
-      * @return A <strong>String</strong> containing the information of this class.
-      */
+     * @return A <strong>String</strong> containing the information of this class.
+     */
     public String toString() {
-    return LEVEL[level] + ":" + getData();
-    }
-    /** Retrieve a textual representation of this index.
-    * @param show_name <i>true</i> if you want the name of this index, <i>false</i> for the gsdl index reference.
-    */
-    public String toString(boolean show_name) {
-    if(show_name) {
-        return getName();
-    }
-    return LEVEL[level] + ":" + getData();
-    }
-    
-    /** Retrieve a textual representation of this index, specifically for the configuration files. Extracted metadata is shown to teh user and stored as ex.MD, however in the config file it should have no namespace */
-    public String toStringConfig() {
-
-    return LEVEL[level] + ":" + getDataConfig();
-    }
-
-    /** Method to parse a configuration file index specification into an Index
-     * object. returns null if invalid syntax */
-    public static Index parseIndexConfig(String entry, CollectionDesignManager manager) {
-    // all (mg) indexes must start with level:
-    if(entry.indexOf(":") == -1) {
-        return null;
-    }
-    
-    String level_str = entry.substring(0, entry.indexOf(":"));
-    String sources_raw = entry.substring(entry.indexOf(":") + 1);
-    Vector sources = new Vector();
-    StringTokenizer st = new StringTokenizer(sources_raw, ",");
-    while(st.hasMoreTokens()) {
-        String token = st.nextToken();
-        // We may have to replace old : with whatever namespace separator we are using.
-        token = token.replace(':', MSMUtils.NS_SEP);
-        // if there is no namespace, we need to add one, except for text
-        if (token.indexOf(MSMUtils.NS_SEP)==-1) {
-        if (!token.equals("text")) {
-            token = Utility.EXTRACTED_METADATA_NAMESPACE+MSMUtils.NS_SEP+token;
-        }
-        }
-        
-        sources.add(token);
-    }
-    Index index = null;
-    for(int i = 0; i < Index.LEVEL.length; i++) {
-        if(level_str.equals(Index.LEVEL[i])) {
-        return new Index(i, sources, manager);
-        
-        }
-    }
-    // somethings gone wrong
-    return null;
-    
-    }
-    
-    /** A custom comparator for comparing Indexes. */
-    private class IndexComparator
-    implements Comparator {
-    /** Method to compare two objects, which may be either indexes or strings.
-     * @param object1 One object as an <strong>Object</strong>.
-     * @param object2 Another object as an <strong>Object</strong>.
-     * @return An <i>int</i> which indicates how they compare.
-     * @see java.lang.String
-     */
-    public int compare(Object object1, Object object2) {
-        if(object1 instanceof Index && object2 instanceof Index) {
-        Index index1 = (Index)object1;
-        Index index2 = (Index)object2;
-        return index1.toString(false).compareTo(index2.toString(false));
-        }
-        else if(object1 instanceof Index) {
-        Index index = (Index) object1;
-        return index.toString(false).compareTo(object2.toString());
-        }
-        else if(object2 instanceof Index) {
-        Index index = (Index) object2;
-        return object1.toString().compareTo(index.toString(false));
-        }
-        return object1.toString().compareTo(object2.toString());
-    }
-    /** Method to test for the equality of two objects, which may be indexes or strings.
-            * @param object Another object as an <strong>Object</strong>.
-            * @return A <i>boolean</i> which is <i>true</i> if the two objects are equal, <i>false</i> otherwise.
-            */
-    public boolean equals(Object object) {
-        if(compareTo(object) == 0) {
-        return true;
-        }
-        return false;
-    }
+    String id = getID();
+    StringBuffer text = new StringBuffer(id);
+    CollectionMeta metadatum = CollectionDesignManager.collectionmeta_manager.getMetadatum(StaticStrings.STOP_CHARACTER + id, false);
+    if(metadatum != null) {
+        text.append(" \"");
+        text.append(metadatum.getValue());
+        text.append("\"");
+    }
+    return text.toString();
     }
 }