source: trunk/gli/src/org/greenstone/gatherer/metadata/DocXMLFile.java@ 7822

package org.greenstone.gatherer.metadata;


import java.io.*;
import java.util.*;
import org.greenstone.gatherer.util.Utility;
import org.w3c.dom.*;


/** This class represents one doc.xml file */
public class DocXMLFile
   extends File
{
   static final private String ARCHIVE_ELEMENT = "Archive";
   static final private String DESCRIPTION_ELEMENT = "Description";
   static final private String METADATA_ELEMENT = "Metadata";
   static final private String SECTION_ELEMENT = "Section";

   private ArrayList files_in_doc_xml_file = new ArrayList();


   public DocXMLFile(String doc_xml_file_path)
   {
      super(doc_xml_file_path);

      // Parse the doc.xml file
      Document document = XMLTools.parseXMLFile(this);
      if (document == null) {
     System.err.println("Error: Could not parse doc.xml file " + getAbsolutePath());
     return;
      }

      // Read all the Archive elements in the file
      NodeList archive_elements_nodelist = document.getElementsByTagName(ARCHIVE_ELEMENT);
      for (int i = 0; i < archive_elements_nodelist.getLength(); i++) {
     Element current_archive_element = (Element) archive_elements_nodelist.item(i);

     // Read the child Section elements of the archive (but not all descendants)
     ArrayList child_section_elements = XMLTools.getChildElementsByTagName(current_archive_element, SECTION_ELEMENT);
     for (int j = 0; j < child_section_elements.size(); j++) {
        Element current_section_element = (Element) child_section_elements.get(j);

        // Read the Description elements of this section only (not child sections as well)
        ArrayList child_description_elements = XMLTools.getChildElementsByTagName(current_section_element, DESCRIPTION_ELEMENT);
        for (int k = 0; k < child_description_elements.size(); k++) {
           Element current_description_element = (Element) child_description_elements.get(k);

           String gsdlsourcefilename_value = null;
           boolean bibliographic_data = false;

           // Read all the Metadata elements in this description element
           NodeList metadata_elements_nodelist = current_description_element.getElementsByTagName(METADATA_ELEMENT);
           for (int l = 0; l < metadata_elements_nodelist.getLength(); l++) {
          Element current_metadata_element = (Element) metadata_elements_nodelist.item(l);
          String metadata_element_name_full = current_metadata_element.getAttribute("name");

          // Note which file this Section is for
          if (metadata_element_name_full.equals("gsdlsourcefilename")) {
             gsdlsourcefilename_value = XMLTools.getElementTextValue(current_metadata_element);
             boolean is_unix_path = gsdlsourcefilename_value.startsWith("/");

             // We're only interested in the path relative to the import folder
             int import_index = gsdlsourcefilename_value.indexOf("import");
             if (import_index != -1) {
            gsdlsourcefilename_value = gsdlsourcefilename_value.substring(import_index + "import".length() + 1);
             }

             // Make sure the path matches the OS that is running
             if (is_unix_path && Utility.isWindows()) {
            // Convert path from Unix to Windows
            gsdlsourcefilename_value = gsdlsourcefilename_value.replaceAll("/", File.separator);
             }
             if (!is_unix_path && !Utility.isWindows()) {
            // Convert path from Windows to Unix
            gsdlsourcefilename_value = gsdlsourcefilename_value.replaceAll("\\", File.separator);
             }

             System.err.println("gsdlsourcefilename: " + gsdlsourcefilename_value);
          }

          // We don't deal with bibliographic data
          if (metadata_element_name_full.equals("SourceSegment")) {
             bibliographic_data = true;
             break;
          }
           }

           // Remember this for quick access later
           if (gsdlsourcefilename_value != null && !bibliographic_data) {
          files_in_doc_xml_file.add(gsdlsourcefilename_value);
           }
        }
     }
      }
   }


   public ArrayList getMetadataExtractedFromFile(File file)
   {
      // Build up a list of metadata extracted from this file
      ArrayList metadata_values = new ArrayList();

      String file_relative_path = file.getAbsolutePath();
      int import_index = file_relative_path.indexOf("import");
      if (import_index != -1) {
     file_relative_path = file_relative_path.substring(import_index + "import".length() + 1);
      }

      // Check whether this doc.xml file contains extracted metadata for the specified file
      boolean contains_extracted_metadata_for_file = false;
      for (int i = 0; i < files_in_doc_xml_file.size(); i++) {
     if (file_relative_path.equals(files_in_doc_xml_file.get(i))) {
        contains_extracted_metadata_for_file = true;
        System.err.println("Found extracted metadata in file " + getAbsolutePath());
        break;
     }
      }

      // ...it doesn't
      if (!contains_extracted_metadata_for_file) {
     return metadata_values;
      }

      // Parse the doc.xml file
      Document document = XMLTools.parseXMLFile(this);
      if (document == null) {
     System.err.println("Error: Could not parse doc.xml file " + getAbsolutePath());
     return metadata_values;
      }

      MetadataSet extracted_metadata_set = MetadataSetManager.getMetadataSet(MetadataSetManager.EXTRACTED_METADATA_NAMESPACE);

      // Read all the Archive elements in the file
      NodeList archive_elements_nodelist = document.getElementsByTagName(ARCHIVE_ELEMENT);
      for (int i = 0; i < archive_elements_nodelist.getLength(); i++) {
     Element current_archive_element = (Element) archive_elements_nodelist.item(i);

     // Read the child Section elements of the archive (but not all descendants)
     ArrayList child_section_elements = XMLTools.getChildElementsByTagName(current_archive_element, SECTION_ELEMENT);
     for (int j = 0; j < child_section_elements.size(); j++) {
        Element current_section_element = (Element) child_section_elements.get(j);

        // Read the Description elements of this section only (not child sections as well)
        ArrayList child_description_elements = XMLTools.getChildElementsByTagName(current_section_element, DESCRIPTION_ELEMENT);
        for (int k = 0; k < child_description_elements.size(); k++) {
           Element current_description_element = (Element) child_description_elements.get(k);

           // Read all the Metadata elements in this description element
           NodeList metadata_elements_nodelist = current_description_element.getElementsByTagName(METADATA_ELEMENT);
           for (int l = 0; l < metadata_elements_nodelist.getLength(); l++) {
          Element current_metadata_element = (Element) metadata_elements_nodelist.item(l);
          String metadata_element_name_full = current_metadata_element.getAttribute("name");

          // If the metadata has no namespace, it is extracted metadata
          String metadata_set_namespace = MetadataTools.getMetadataSetNamespace(metadata_element_name_full);
          if (metadata_set_namespace.equals("")) {
             metadata_set_namespace = MetadataSetManager.EXTRACTED_METADATA_NAMESPACE;

             // We're not interested in lower-case metadata elements (gsdlsourcefilename, gsdlassocfile etc.)
             if (Character.isLowerCase(metadata_element_name_full.charAt(0))) {
            continue;
             }

             MetadataElement metadata_element = extracted_metadata_set.getMetadataElement(metadata_element_name_full);
             if (metadata_element == null) {
            metadata_element_name_full = metadata_set_namespace + MetadataTools.NAMESPACE_SEPARATOR + metadata_element_name_full;
            metadata_element = new MetadataElement(metadata_element_name_full, null);
             }

             // Value trees are not stored for extracted metadata, so create a new value tree node now
             String current_metadata_element_value = XMLTools.getElementTextValue(current_metadata_element);
             metadata_element.addMetadataValue(current_metadata_element_value);
             MetadataValueTreeNode metadata_value_tree_node = metadata_element.getMetadataValueTreeNode(current_metadata_element_value);

             // Add the new metadata value to the list
             MetadataValue metadata_value = new MetadataValue(metadata_element, metadata_value_tree_node);
             metadata_values.add(metadata_value);
          }
           }
        }
     }
      }

      return metadata_values;
   }
}