Changeset 5944 for trunk/gsdl3/src/java/org/greenstone/gsdl3/gs3build/doctypes/AbstractDocument.java

Timestamp:

2003-11-24T14:26:35+13:00 (20 years ago)

Author:

cs025

Message:

Index document type, metadata extensions

File:

• trunk/gsdl3/src/java/org/greenstone/gsdl3/gs3build/doctypes/AbstractDocument.java (modified) (10 diffs)

trunk/gsdl3/src/java/org/greenstone/gsdl3/gs3build/doctypes/AbstractDocument.java

@@ -3 +3 @@
 import java.util.List;
 import java.util.ArrayList;
+import java.util.Iterator;
 import java.util.HashMap;
 import java.util.Map;
+
+import java.sql.SQLException;
+import java.sql.ResultSet;
+
 import java.net.URL;
 
@@ -19 +24 @@
 
 import org.greenstone.gsdl3.gs3build.util.MultiMap;
+import org.greenstone.gsdl3.gs3build.util.GS3SQLConnection;
 
 /**
@@ -32 +38 @@
   METSHeader       header;
   DocumentID       id;
+  boolean          isModified;
+
+  /**
+   *  <p>Create a very vanilla document with a given document identifier.</p>
+   *  <p>Most commonly used in dealing with loading files using DocumentFactory
+   *  or similar.</p>
+   *
+   *  @param <code>DocumentID</code> the document identifier
+   */
+  public AbstractDocument(DocumentID id)
+  { this.fileSet      = new METSFileSet();
+    this.metadata     = new METSDescriptiveSet();
+    this.header       = new METSHeader();
+    this.structureSet = new METSStructureSet();
+    this.id           = id;
+  }
   
+  /**
+   *  Create a basic document from a given <code>URL</code.  This is usually the form
+   *  called through the recognisers.
+   *
+   *  @param <code>URL</code> the URL of the first file in the document package
+   */
   public AbstractDocument(URL url)
   { this.fileSet      = new METSFileSet();
@@ -39 +67 @@
     this.header       = new METSHeader();
     this.structureSet = new METSStructureSet();
+    this.id           = null;
 
     METSStructure structure = new METSStructure("All", "All", "Whole Document");
@@ -131 +160 @@
       namespace = GSDL3Namespace.GSDL3_NAMESPACE_ID;
     }
+
+    // no need to set isModified, as the following call will do it anyway!
     this.addDocumentMetadata(namespace, name, value);
   }
@@ -139 +170 @@
   public void addDocumentMetadata(String namespace, String label, String value)
   { this.metadata.addMetadata("default", namespace, label, value);
-  }
-
-  /**
-   *  @see DocumentInterace:setDocumentMetadata
+    this.isModified = true;
+  }
+
+  /**
+   *  Post metadata to a file in this document - the appropriate changes
+   *  should be made...
+   */
+  public void postFileMetadata(URL fileLocation, String namespace, String label, String value)
+  {
+    // First get the list of file groups, etc. that this file is associated with...
+    List fileGroups = this.fileSet.findGroups(fileLocation);
+
+    // Next, get the METS divisions associated with each file group...
+    List divisions = this.structureSet.findDivisionsForFiles(fileGroups);
+    
+    // Finally, post the metadata to the metadata group associated with each structure
+    Iterator divisionIter = divisions.iterator();
+    while (divisionIter.hasNext())
+    { METSDivision division = (METSDivision) divisionIter.next();
+
+      // get the open namespace for this division
+      METSNamespace namespaceMetadata = division.findNamespace(namespace, true, this.metadata);
+
+      // then post the metadata to it...
+      namespaceMetadata.addMetadata(label, value);
+    }
+  }
+
+  /**
+   *  @see DocumentInterface:setDocumentMetadata
    */
   public void setDocumentMetadata(String namespace, String label, String value)
   { this.metadata.setMetadata("default", namespace, label, value);
+    this.isModified = true;
   }
 
@@ -158 +216 @@
 
   /**
+   *  Set the metadata structure for this document
+   *
+   *  @param <code>METSDescriptive</code> the new metadata holder for the document.
+   */
+  public void setDocumentMetadata(METSDescriptiveSet metadata)
+  { this.metadata = metadata;
+    this.isModified = true;
+  }
+
+  /**
    *  Get the metadata structure of the document
    *
@@ -164 +232 @@
   public METSStructureSet getDocumentStructure()
   { return this.structureSet;
+  }
+
+  public void setDocumentStructure(METSStructureSet structureSet)
+  { this.structureSet = structureSet;
   }
 
@@ -207 +279 @@
   { return this.fileSet;
   }
+
+  public void setDocumentFiles(METSFileSet fileSet)
+  { this.fileSet = fileSet;
+  }
   
   /**
@@ -231 +307 @@
   { return new DocumentSQLWriter();
   }
-    
+
+  /**
+   *  Obtain a document from the SQL database
+   */
+  public static AbstractDocument readSQL(GS3SQLConnection connection, ResultSet sqlResult)
+  { try {
+      DocumentID id = new DocumentID(sqlResult.getString("DocID"));
+      String     type = sqlResult.getString("docType");
+
+      // Use a factory method to create the correct subtype...
+      AbstractDocument document = DocumentFactory.createDocument(type, id);
+
+      // Get the individual components of the document
+      METSFileSet fileSet = METSFileSet.readSQL(document, connection);
+      document.setDocumentFiles(fileSet);
+      METSDescriptiveSet descriptiveSet = METSDescriptiveSet.readSQL(document, connection);
+      document.setDocumentMetadata(descriptiveSet);
+      METSStructureSet structureSet = METSStructureSet.readSQL(document, connection);
+      document.setDocumentStructure(structureSet);
+
+      // indicate that the document is not currently modified
+      document.setModified(false);
+      return document;
+    }
+    catch (SQLException sqlEx) {
+    }
+    return null;
+  }
+
+  /**
+   *  
+   */
+  public boolean isModified()
+  { return this.isModified;
+  }
+
+  public void setModified(boolean isModified)
+  { this.isModified = isModified;
+  }
 }