Changeset 36138

Timestamp:

2022-04-12T11:04:26+12:00 (2 years ago)

Author:

kjdon

Message:

split Index into 2 classes - Index: for mgpp/lucene/solr indexes, and MGIndex, which inherits from Index, for MG indexes.

Location:

main/trunk/gli/src/org/greenstone/gatherer/cdm

Files:

• Index.java (modified) (8 diffs)
• MGIndex.java (added)

main/trunk/gli/src/org/greenstone/gatherer/cdm/Index.java

@@ -36 +36 @@
 import org.w3c.dom.*;
 
-/** This class encapsulates a single indexing pair.
+/** This class encapsulates a single index. MGPP/Lucene/SOLR
+ * Can be subclassed for Sort fields and facet fields
  * @author John Thompson, Greenstone Digital Library, University of Waikato
  * @version 2.3d
@@ -42 +43 @@
 public class Index
     implements Comparable, DOMProxyListEntry {
-    /** An values of items in the index level enumeration. */
-    static protected final String LEVEL[] = {StaticStrings.DOCUMENT_STR,  StaticStrings.SECTION_STR, StaticStrings.PARAGRAPH_STR};
-
-    private ArrayList sources = null;
-    /** The level of this index (if old sckool MG). */
-    private int level = -1;
+
+    protected ArrayList sources = null;
+
     /** The element this index is based upon. */
-    private Element element = null;
+    protected Element element = null;
+    /** The name for our elements */
+    protected String element_name = StaticStrings.INDEX_ELEMENT;
+    /** The name for the default element */
+    protected String default_element_name = StaticStrings.INDEX_DEFAULT_ELEMENT;
     /** The unique, if cryptic, identifier of an index. */
-    private String id = null;
+    protected String id = null;
 
     /** Default constructor, which should only be used during DOMProxyListModel creation. */
@@ -66 +68 @@
     this.sources = sources;
     // Create a new element
-    this.element = CollectionConfiguration.createElement(StaticStrings.INDEX_ELEMENT);
+    this.element = CollectionConfiguration.createElement(this.element_name);
     // For each source add a content element
     int size = sources.size();
@@ -85 +87 @@
     }
 
-    /** Constructor for a newly assigned index with specified level (old skool). */
-    public Index(int level, ArrayList sources) {
-    this(sources);
-    this.level = level;
-    element.setAttribute(StaticStrings.LEVEL_ATTRIBUTE, LEVEL[level]);
-    }
-
-    public Index(String level, ArrayList sources) {
-    this(sources);
-    for(int i = 0; i < LEVEL.length; i++) {
-        if(LEVEL[i].equalsIgnoreCase(level)) {
-        this.level = i;
-        }
-    }
-    element.setAttribute(StaticStrings.LEVEL_ATTRIBUTE, LEVEL[this.level]);
-    }
-
     /** Method to compare two indexes.
      * @param object The other index as an <strong>Object</strong>.
@@ -130 +115 @@
     return element;
     }
-    
-    /** Method to get the value of level.
-     * @return the level as a int
-     */
-    public int getLevel() {
-    if(level == -1 && element != null) {
-        String level_str = element.getAttribute(StaticStrings.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;
-    }
 
     public String getID() {
@@ -153 +122 @@
     else 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();
@@ -225 +188 @@
     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 new_level the new level as an int
-     */
-    public void setLevel(int new_level) {
-    // System.err.println("SetLevel(" + new_level + ")");
-    if(element != null && element.getNodeName().equals(StaticStrings.INDEX_DEFAULT_ELEMENT)) {
-        if (0 <= new_level && new_level < 3) {
-        element.setAttribute(StaticStrings.LEVEL_ATTRIBUTE, LEVEL[new_level]);
-        } else {
-        element.setAttribute(StaticStrings.LEVEL_ATTRIBUTE, "");
-        }
-        this.id = null; // Regenerate ID.
-        this.level = new_level;
-    }
-    else {
-        DebugStream.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(StaticStrings.INDEX_DEFAULT_ELEMENT)) {
+    if(element != null && element.getNodeName().equals(this.default_element_name)) {
         // Erase old sources
         XMLTools.clear(element);
@@ -288 +231 @@
     StringBuffer text_buffer = new StringBuffer("");
     // Generate language dependant id (include extracted metadata namespace)
-    // Write level information, if any.
-    int level = getLevel();
-    if(0 <= level && level < 3) {
-        text_buffer.append(LEVEL[level]);
-        text_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();