hydra-pbcore 0.0.1

data/lib/hydra-pbcore/datastream/document.rb

@@ -0,0 +1,325 @@
+module HydraPbcore::Datastream
+class Document < ActiveFedora::NokogiriDatastream
+
+	include HydraPbcore::Methods
+
+  set_terminology do |t|
+    t.root(:path=>"pbcoreDescriptionDocument", :xmlns => '', :namespace_prefix=>nil)
+
+    #
+    #  pbcoreDescription fields
+    #
+    t.pbc_id(:path=>"pbcoreIdentifier", :namespace_prefix=>nil, :namespace_prefix=>nil, :attributes=>{ :source=>"Rock and Roll Hall of Fame and Museum", :annotation=>"PID" })
+
+    t.main_title(:path=>"pbcoreTitle", :namespace_prefix=>nil, :namespace_prefix=>nil, :attributes=>{ :titleType=>"Main" })
+    t.alternative_title(:path=>"pbcoreTitle", :namespace_prefix=>nil, :namespace_prefix=>nil, :attributes=>{ :titleType=>"Alternative" })
+    t.chapter(:path=>"pbcoreTitle", :namespace_prefix=>nil, :namespace_prefix=>nil, :attributes=>{ :titleType=>"Chapter" })
+    t.episode(:path=>"pbcoreTitle", :namespace_prefix=>nil, :attributes=>{ :titleType=>"Episode" })
+    t.label(:path=>"pbcoreTitle", :namespace_prefix=>nil, :attributes=>{ :titleType=>"Label" })
+    t.segment(:path=>"pbcoreTitle", :namespace_prefix=>nil, :attributes=>{ :titleType=>"Segment" })
+    t.subtitle(:path=>"pbcoreTitle", :namespace_prefix=>nil, :attributes=>{ :titleType=>"Subtitle" })
+    t.track(:path=>"pbcoreTitle", :namespace_prefix=>nil, :attributes=>{ :titleType=>"Track" })
+    t.translation(:path=>"pbcoreTitle", :namespace_prefix=>nil, :attributes=>{ :titleType=>"Translation" })
+
+    # This is only to display all subjects
+    t.subjects(:path=>"pbcoreSubject", :namespace_prefix=>nil)
+
+    # Individual subject types defined for entry
+    t.lc_subject(:path=>"pbcoreSubject", :namespace_prefix=>nil, :attributes=>{ :source=>"Library of Congress Subject Headings", :ref=>"http://id.loc.gov/authorities/subjects.html" })
+    t.lc_name(:path=>"pbcoreSubject", :namespace_prefix=>nil, :attributes=>{ :source=>"Library of Congress Name Authority File", :ref=>"http://id.loc.gov/authorities/names" })
+    t.rh_subject(:path=>"pbcoreSubject", :namespace_prefix=>nil, :attributes=>{ :source=>"Rock and Roll Hall of Fame and Museum" })
+
+    t.summary(:path=>"pbcoreDescription", :namespace_prefix=>nil, :attributes=>{ :descriptionType=>"Description",
+      :descriptionTypeSource=>"pbcoreDescription/descriptionType",
+      :descriptionTypeRef=>"http://pbcore.org/vocabularies/pbcoreDescription/descriptionType#description",
+      :annotation=>"Summary"}
+    )
+
+    t.parts_list(:path=>"pbcoreDescription", :namespace_prefix=>nil, :attributes=>{ :descriptionType=>"Table of Contents",
+      :descriptionTypeSource=>"pbcoreDescription/descriptionType",
+      :descriptionTypeRef=>"http://pbcore.org/vocabularies/pbcoreDescription/descriptionType#table-of-contents",
+      :annotation=>"Parts List" }
+    )
+
+    # This is only to display all genres
+    t.genres(:path=>"pbcoreGenre", :namespace_prefix=>nil)
+
+    # Individual genre types defined for entry
+    t.getty_genre(:path=>"pbcoreGenre", :namespace_prefix=>nil, :attributes=>{ :source=>"The Getty Research Institute Art and Architecture Thesaurus", :ref=>"http://www.getty.edu/research/tools/vocabularies/aat/index.html" })
+    t.lc_genre(:path=>"pbcoreGenre", :namespace_prefix=>nil, :attributes=>{ :source=>"Library of Congress Genre/Form Terms", :ref=>"http://id.loc.gov/authorities/genreForms.html" })
+    t.lc_subject_genre(:path=>"pbcoreGenre", :namespace_prefix=>nil, :attributes=>{ :source=>"Library of Congress Subject Headings", :ref=>"http://id.loc.gov/authorities/subjects.html" })
+
+
+    # Series field
+    t.pbcoreRelation(:namespace_prefix=>nil) {
+      t.pbcoreRelationIdentifier(:namespace_prefix=>nil, :attributes=>{ :annotation=>"Event Series" })
+    }
+    t.event_series(:ref=>[:pbcoreRelation, :pbcoreRelationIdentifier])
+
+    # Terms for time and place
+    t.pbcore_coverage(:path=>"pbcoreCoverage", :namespace_prefix=>nil) {
+      t.coverage(:path=>"coverage", :namespace_prefix=>nil)
+    }
+    t.spatial(:ref => :pbcore_coverage,
+      :path=>'pbcoreCoverage[coverageType="Spatial"]',
+      :namespace_prefix=>nil
+    )
+    t.temporal(:ref => :pbcore_coverage,
+      :path=>'pbcoreDescriptionDocument/pbcoreCoverage[coverageType="Temporal"]',
+      :namespace_prefix=>nil
+    )
+    t.event_place(:proxy=>[:spatial, :coverage])
+    t.event_date(:proxy=>[:temporal, :coverage])
+
+    # Contributor names and roles
+    t.contributor(:path=>"pbcoreContributor", :namespace_prefix=>nil) {
+      t.name_(:path=>"contributor", :namespace_prefix=>nil)
+      t.role_(:path=>"contributorRole", :namespace_prefix=>nil, :attributes=>{ :source=>"MARC relator terms" })
+    }
+    t.contributor_name(:proxy=>[:contributor, :name])
+    t.contributor_role(:proxy=>[:contributor, :role])
+
+    # Publisher names and roles
+    t.publisher(:path=>"pbcorePublisher", :namespace_prefix=>nil) {
+      t.name_(:path=>"publisher", :namespace_prefix=>nil)
+      t.role_(:path=>"publisherRole", :namespace_prefix=>nil, :attributes=>{ :source=>"PBCore publisherRole" })
+    }
+    t.publisher_name(:proxy=>[:publisher, :name])
+    t.publisher_role(:proxy=>[:publisher, :role])
+
+    t.note(:path=>"pbcoreAnnotation", :namespace_prefix=>nil, :atttributes=>{ :annotationType=>"Notes" })
+
+    #
+    # pbcoreInstantiation fields for the physical item
+    #
+    t.pbcoreInstantiation(:namespace_prefix=>nil) {
+      t.instantiationIdentifier(:namespace_prefix=>nil, :attributes=>{ :annotation=>"Barcode", :source=>"Rock and Roll Hall of Fame and Museum" })
+      t.instantiationDate(:namespace_prefix=>nil, :attributes=>{ :dateType=>"created" })
+      t.instantiationPhysical(:namespace_prefix=>nil, :attributes=>{ :source=>"PBCore instantiationPhysical" })
+      t.instantiationStandard(:namespace_prefix=>nil)
+      t.instantiationLocation(:namespace_prefix=>nil)
+      t.instantiationMediaType(:namespace_prefix=>nil, :attributes=>{ :source=>"PBCore instantiationMediaType" })
+      t.instantiationGenerations(:namespace_prefix=>nil, :attributes=>{ :source=>"PBCore instantiationGenerations" })
+      t.instantiationColors(:namespace_prefix=>nil)
+      t.instantiationLanguage(:namespace_prefix=>nil, :attributes=>{ :source=>"ISO 639.2", :ref=>"http://www.loc.gov/standards/iso639-2/php/code_list.php" })
+      t.instantiationRelation(:namespace_prefix=>nil) {
+        t.arc_collection(:path=>"instantiationRelationIdentifier", :namespace_prefix=>nil, :attributes=>{ :annotation=>"Archival collection" })
+        t.arc_series(:path=>"instantiationRelationIdentifier", :namespace_prefix=>nil, :attributes=>{ :annotation=>"Archival Series" })
+        t.col_number(:path=>"instantiationRelationIdentifier", :namespace_prefix=>nil, :attributes=>{ :annotation=>"Collection Number" })
+        t.acc_number(:path=>"instantiationRelationIdentifier", :namespace_prefix=>nil, :attributes=>{ :annotation=>"Accession Number" })
+      }
+      t.instantiationRights(:namespace_prefix=>nil) {
+        t.rightsSummary(:namespace_prefix=>nil)
+      }
+      t.inst_cond_note(:path=>"instantiationAnnotation", :namespace_prefix=>nil, :attributes=>{ :annotationType=>"Condition Notes" })
+      t.inst_clean_note(:path=>"instantiationAnnotation", :namespace_prefix=>nil, :attributes=>{ :annotationType=>"Cleaning Notes" })
+    }
+    # Individual field names:
+    t.creation_date(:proxy=>[:pbcoreInstantiation, :instantiationDate])
+    t.barcode(:proxy=>[:pbcoreInstantiation, :instantiationIdentifier])
+    t.repository(:proxy=>[:pbcoreInstantiation, :instantiationLocation])
+    t.format(:proxy=>[:pbcoreInstantiation, :instantiationPhysical])
+    t.standard(:proxy=>[:pbcoreInstantiation, :instantiationStandard])
+    t.media_type(:proxy=>[:pbcoreInstantiation, :instantiationMediaType])
+    t.generation(:proxy=>[:pbcoreInstantiation, :instantiationGenerations])
+    t.language(:proxy=>[:pbcoreInstantiation, :instantiationLanguage])
+    t.colors(:proxy=>[:pbcoreInstantiation, :instantiationColors])
+    t.archival_collection(:proxy=>[:pbcoreInstantiation, :instantiationRelation, :arc_collection])
+    t.archival_series(:proxy=>[:pbcoreInstantiation, :instantiationRelation, :arc_series])
+    t.collection_number(:proxy=>[:pbcoreInstantiation, :instantiationRelation, :col_number])
+    t.accession_number(:proxy=>[:pbcoreInstantiation, :instantiationRelation, :acc_number])
+    t.usage(:proxy=>[:pbcoreInstantiation, :instantiationRights, :rightsSummary])
+    t.condition_note(:proxy=>[:pbcoreInstantiation, :inst_cond_note])
+    t.cleaning_note(:proxy=>[:pbcoreInstantiation, :inst_clean_note])
+
+    #
+    # pbcorePart fields
+    #
+    t.pbcorePart(:namespace_prefix=>nil) {
+      t.pbcoreTitle(:namespace_prefix=>nil, :attributes=>{ :titleType=>"song", :annotation=>"part title" })
+      t.pbcoreIdentifier(:namespace_prefix=>nil, :attributes=>{ :source=>"rock hall", :annotation=>"part number" })
+      t.pbcoreDescription(:namespace_prefix=>nil, :attributes=>{ :descriptionType=>"Description",
+        :descriptionTypesource=>"pbcoreDescription/descriptionType",
+        :ref=>"http://pbcore.org/vocabularies/pbcoreDescription/descriptionType#description" }
+      )
+      t.pbcoreContributor(:namespace_prefix=>nil, :xmlns => '') {
+        t.contributor(:namespace_prefix=>nil, :attributes=>{ :annotation=>"part contributor" })
+        t.contributorRole(:namespace_prefix=>nil, :attributes=>{ :source=>"MARC relator terms" })
+      }
+    }
+    t.part_title(:ref=>[:pbcorePart, :pbcoreTitle])
+    t.part_number(:ref=>[:pbcorePart, :pbcoreIdentifier])
+    t.part_description(:ref=>[:pbcorePart, :pbcoreDescription])
+    t.part_contributor(:ref=>[:pbcorePart, :pbcoreContributor, :contributor])
+    t.part_role(:ref=>[:pbcorePart, :pbcoreContributor, :contributorRole])
+
+  end
+
+
+  def self.xml_template
+    builder = Nokogiri::XML::Builder.new do |xml|
+
+      xml.pbcoreDescriptionDocument("xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
+        "xsi:schemaLocation"=>"http://www.pbcore.org/PBCore/PBCoreNamespace.html") {
+
+        xml.pbcoreIdentifier(:source=>"Rock and Roll Hall of Fame and Museum", :annotation=>"PID")
+        xml.pbcoreTitle(:titleType=>"Main")
+        xml.pbcoreDescription(:descriptionType=>"Description",
+          :descriptionTypeSource=>"pbcoreDescription/descriptionType",
+          :descriptionTypeRef=>"http://pbcore.org/vocabularies/pbcoreDescription/descriptionType#description",
+          :annotation=>"Summary"
+        )
+        xml.pbcoreDescription(:descriptionType=>"Table of Contents",
+          :descriptionTypeSource=>"pbcoreDescription/descriptionType",
+          :descriptionTypeRef=>"http://pbcore.org/vocabularies/pbcoreDescription/descriptionType#table-of-contents",
+          :annotation=>"Parts List"
+        )
+        xml.pbcoreRelation {
+          xml.pbcoreRelationType(:source=>"PBCore relationType", :ref=>"http://pbcore.org/vocabularies/relationType#is-part-of") {
+            xml.text "Is Part Of"
+          }
+          xml.pbcoreRelationIdentifier(:annotation=>"Event Series")
+        }
+        xml.pbcoreCoverage {
+          xml.coverage(:annotation=>"Event Place")
+          xml.coverageType {
+            xml.text "Spatial"
+          }
+        }
+        xml.pbcoreCoverage {
+          xml.coverage(:annotation=>"Event Date")
+          xml.coverageType {
+            xml.text "Temporal"
+          }
+        }
+        xml.pbcoreAnnotation(:annotationType=>"Notes")
+
+        #
+        # Default physical item
+        #
+        xml.pbcoreInstantiation {
+
+          # Item details
+          xml.instantiationIdentifier(:annotation=>"Barcode", :source=>"Rock and Roll Hall of Fame and Museum")
+          xml.instantiationDate(:dateType=>"created")
+          xml.instantiationPhysical(:source=>"PBCore instantiationPhysical")
+          xml.instantiationStandard
+          xml.instantiationLocation {
+            xml.text "Rock and Roll Hall of Fame and Museum,\n2809 Woodland Ave.,\nCleveland, OH, 44115\n216-515-1956\nlibrary@rockhall.org"
+          }
+          xml.instantiationMediaType(:source=>"PBCore instantiationMediaType") {
+            xml.text "Moving image"
+          }
+          xml.instantiationGenerations(:source=>"PBCore instantiationGenerations") {
+            xml.text "Original"
+          }
+          xml.instantiationColors {
+            xml.text "Color"
+          }
+          xml.instantiationLanguage(:source=>"ISO 639.2", :ref=>"http://www.loc.gov/standards/iso639-2/php/code_list.php") {
+            xml.text "eng"
+          }
+          xml.instantiationRelation {
+            xml.instantiationRelationType(:source=>"PBCore relationType", :ref=>"http://pbcore.org/vocabularies/relationType#is-part-of") {
+              xml.text "Is Part Of"
+            }
+            xml.instantiationRelationIdentifier(:annotation=>"Archival Collection")
+          }
+          xml.instantiationRelation {
+            xml.instantiationRelationType(:source=>"PBCore relationType", :ref=>"http://pbcore.org/vocabularies/relationType#is-part-of") {
+              xml.text "Is Part Of"
+            }
+            xml.instantiationRelationIdentifier(:annotation=>"Archival Series")
+          }
+          xml.instantiationRelation {
+            xml.instantiationRelationType(:source=>"PBCore relationType", :ref=>"http://pbcore.org/vocabularies/relationType#is-part-of") {
+              xml.text "Is Part Of"
+            }
+            xml.instantiationRelationIdentifier(:annotation=>"Collection Number")
+          }
+          xml.instantiationRelation {
+            xml.instantiationRelationType(:source=>"PBCore relationType", :ref=>"http://pbcore.org/vocabularies/relationType#is-part-of") {
+              xml.text "Is Part Of"
+            }
+            xml.instantiationRelationIdentifier(:annotation=>"Accession Number")
+          }
+          xml.instantiationRights {
+            xml.rightsSummary
+          }
+
+        }
+
+      }
+
+    end
+    return builder.doc
+  end
+
+
+  def to_solr(solr_doc=Solr::Document.new)
+    super(solr_doc)
+
+    solr_doc.merge!(:format => "Video")
+    solr_doc.merge!(:title_t => self.find_by_terms(:main_title).text)
+
+    # Specific fields for Blacklight export
+
+    # Title fields
+    solr_doc.merge!(:title_display => self.find_by_terms(:main_title).text)
+    ["alternative_title", "chapter", "episode", "label", "segment", "subtitle", "track", "translation"].each do |addl_title|
+      solr_doc.merge!(:title_addl_display => self.find_by_terms(addl_title.to_sym).text)
+    end
+    solr_doc.merge!(:heading_display => self.find_by_terms(:main_title).text)
+
+    # Individual fields
+    solr_doc.merge!(:summary_display => self.find_by_terms(:summary).text)
+    solr_doc.merge!(:pub_date_display => self.find_by_terms(:event_date).text)
+    solr_doc.merge!(:publisher_display => gather_terms(self.find_by_terms(:publisher_name)))
+    solr_doc.merge!(:contributors_display => format_contributors_display)
+    solr_doc.merge!(:subject_display => gather_terms(self.find_by_terms(:subjects)))
+    solr_doc.merge!(:genre_display => gather_terms(self.find_by_terms(:genres)))
+    solr_doc.merge!(:series_display => gather_terms(self.find_by_terms(:event_series)))
+    solr_doc.merge!(:physical_dtl_display => gather_terms(self.find_by_terms(:format)))
+    solr_doc.merge!(:recinfo_display => gather_terms(self.find_by_terms(:event_place)))
+    solr_doc.merge!(:recinfo_display => gather_terms(self.find_by_terms(:event_date)))
+    solr_doc.merge!(:contents_display => gather_terms(self.find_by_terms(:parts_list)))
+    solr_doc.merge!(:notes_display => gather_terms(self.find_by_terms(:note)))
+    solr_doc.merge!(:access_display => gather_terms(self.find_by_terms(:usage)))
+    solr_doc.merge!(:collection_display => gather_terms(self.find_by_terms(:archival_collection)))
+
+    # Blacklight facets - these are the same facet fields used in our Blacklight app
+    # for consistency and so they'll show up when we export records from Hydra into BL:
+    solr_doc.merge!(:material_facet => "Digital")
+    solr_doc.merge!(:genre_facet => gather_terms(self.find_by_terms(:genres)))
+    solr_doc.merge!(:name_facet => gather_terms(self.find_by_terms(:contributor_name)))
+    solr_doc.merge!(:subject_topic_facet => gather_terms(self.find_by_terms(:subjects)))
+    solr_doc.merge!(:series_facet => gather_terms(self.find_by_terms(:event_series)))
+    solr_doc.merge!(:format_facet => gather_terms(self.find_by_terms(:format)))
+    solr_doc.merge!(:collection_facet => gather_terms(self.find_by_terms(:archival_collection)))
+
+    # TODO: map PBcore's three-letter language codes to full language names
+    # Right now, everything's English.
+    if self.find_by_terms(:language).text.match("eng")
+      solr_doc.merge!(:language_facet => "English")
+      solr_doc.merge!(:language_display => "English")
+    else
+      solr_doc.merge!(:language_facet => "Unknown")
+      solr_doc.merge!(:language_display => "Unknown")
+    end
+
+    # Extract 4-digit year for creation date facet in Hydra and pub_date facet in Blacklight
+		create = self.find_by_terms(:creation_date).text.strip
+		unless create.nil? or create.empty?
+		  solr_doc.merge!(:create_date_facet => get_year(create))
+		  solr_doc.merge!(:pub_date => get_year(create))
+		end
+
+		# For full text, we stuff it into the mods_t field which is already configured for Mods doucments
+		solr_doc.merge!(:mods_t => self.ng_xml.text)
+
+    return solr_doc
+  end
+
+
+end
+end

data/lib/hydra-pbcore/datastream/instantiation.rb

@@ -0,0 +1,210 @@
+module HydraPbcore::Datastream
+class Instantiation < ActiveFedora::NokogiriDatastream
+
+  include HydraPbcore::Methods
+
+  # Note: this is not a complete PBCore document, just an instantiation node
+  set_terminology do |t|
+    t.root(:path=>"pbcoreDescriptionDocument", :xmlns => '', :namespace_prefix=>nil)
+
+    t.pbcoreInstantiation(:namespace_prefix=>nil) {
+
+      t.instantiationIdentifier(:namespace_prefix=>nil, :attributes=>{ :annotation=>"Filename", :source=>"Rock and Roll Hall of Fame and Museum" })
+      t.instantiationDate(:namespace_prefix=>nil, :attributes=>{ :dateType=>"created" })
+      t.instantiationDigital(:namespace_prefix=>nil, :attributes=>{ :source=>"EBU file formats" })
+      t.instantiationStandard(:namespace_prefix=>nil)
+      t.instantiationLocation(:namespace_prefix=>nil)
+      t.instantiationGenerations(:namespace_prefix=>nil, :attributes=>{ :source=>"PBCore instantiationGenerations" })
+      t.instantiationFileSize(:namespace_prefix=>nil) {
+        t.units(:path=>{:attribute=>"unitsOfMeasure"}, :namespace_prefix=>nil)
+      }
+      t.instantiationColors(:namespace_prefix=>nil, :attributes=>{ :source=>"PBCore instantiationColors" })
+      t.instantiationMediaType(:namespace_prefix=>nil, :attributes=>{ :source=>"PBCore instantiationMediaType" })
+      t.instantiationLanguage(:namespace_prefix=>nil, :attributes=>{ :source=>"ISO 639.2", :ref=>"http://www.loc.gov/standards/iso639-2/php/code_list.php" })
+      t.instantiationDuration(:namespace_prefix=>nil)
+
+      t.instantiationRights(:namespace_prefix=>nil) {
+        t.rightsSummary(:namespace_prefix=>nil)
+      }
+
+      t.instantiationEssenceTrack(:namespace_prefix=>nil) {
+        t.essenceTrackStandard(:namespace_prefix=>nil)
+        t.essenceTrackEncoding( :namespace_prefix=>nil, :attributes=>{ :source=>"PBCore essenceTrackEncoding" })
+        t.essenceTrackDataRate(:namespace_prefix=>nil) {
+          t.units(:path=>{:attribute=>"unitsOfMeasure"}, :namespace_prefix=>nil)
+        }
+        t.essenceTrackFrameRate(:namespace_prefix=>nil, :attributes=>{ :unitsOfMeasure=>"fps" })
+        t.essenceTrackFrameSize(:namespace_prefix=>nil, :attributes=>{ :source=>"PBCore essenceTrackFrameSize" })
+        t.essenceTrackBitDepth(:namespace_prefix=>nil)
+        t.essenceTrackAspectRatio(:namespace_prefix=>nil, :attributes=>{ :source=>"PBCore essenceTrackAspectRatio" })
+        t.essenceTrackSamplingRate(:namespace_prefix=>nil) {
+          t.units(:path=>{:attribute=>"unitsOfMeasure"}, :namespace_prefix=>nil)
+        }
+        t.essenceTrackAnnotation( :namespace_prefix=>nil, :attributes=>{ :annotationType=>"Number of Audio Channels" })
+      }
+      t.video_essence(:ref => [:pbcoreInstantiation, :instantiationEssenceTrack],
+        :path=>'instantiationEssenceTrack[essenceTrackType="Video"]',
+        :namespace_prefix=>nil
+      )
+      t.audio_essence(:ref => [:pbcoreInstantiation, :instantiationEssenceTrack],
+        :path=>'instantiationEssenceTrack[essenceTrackType="Audio"]',
+        :namespace_prefix=>nil
+      )
+
+      t.instantiationRelation(:namespace_prefix=>nil) {
+        t.instantiationRelationIdentifier(:namespace_prefix=>nil, :attributes=>{ :source=>"Rock and Roll Hall of Fame and Museum" })
+      }
+      # The file we're describing at the root of this document preceeds the file marked "next"
+      t.next_inst(:ref => [:pbcoreInstantiation, :instantiationRelation],
+      :path=>'instantiationRelation[instantiationRelationType="Precedes in Sequence"]',
+      :namespace_prefix=>nil
+      )
+      # The file we're describing at the root of this document comes after the file marked "previous"
+      t.previous_inst(:ref => [:pbcoreInstantiation, :instantiationRelation],
+      :path=>'instantiationRelation[instantiationRelationType="Follows in Sequence"]',
+      :namespace_prefix=>nil
+      )
+
+      # Instantitation annotiations
+      t.inst_chksum_type(:path=>"instantiationAnnotation", :namespace_prefix=>nil, :attributes=>{ :annotationType=>"Checksum Type" })
+      t.inst_chksum_value(:path=>"instantiationAnnotation", :namespace_prefix=>nil, :attributes=>{ :annotationType=>"Checksum Value" })
+      t.inst_device(:path=>"instantiationAnnotation", :namespace_prefix=>nil, :attributes=>{ :annotationType=>"Playback Device" })
+      t.inst_capture_soft(:path=>"instantiationAnnotation", :namespace_prefix=>nil, :attributes=>{ :annotationType=>"Capture Software" })
+      t.inst_trans_soft(:path=>"instantiationAnnotation", :namespace_prefix=>nil, :attributes=>{ :annotationType=>"Transcoding Software" })
+      t.inst_operator(:path=>"instantiationAnnotation", :namespace_prefix=>nil, :attributes=>{ :annotationType=>"Operator" })
+      t.inst_trans_note(:path=>"instantiationAnnotation", :namespace_prefix=>nil, :attributes=>{ :annotationType=>"Transfer Notes" })
+      t.inst_vendor(:path=>"instantiationAnnotation", :namespace_prefix=>nil, :attributes=>{ :annotationType=>"Vendor Name" })
+      t.inst_cond_note(:path=>"instantiationAnnotation", :namespace_prefix=>nil, :attributes=>{ :annotationType=>"Condition Notes" })
+      t.inst_clean_note(:path=>"instantiationAnnotation", :namespace_prefix=>nil, :attributes=>{ :annotationType=>"Cleaning Notes" })
+      t.inst_note(:path=>"instantiationAnnotation", :namespace_prefix=>nil, :attributes=>{ :annotationType=>"Notes" })
+      t.inst_color_space(:path=>"instantiationAnnotation", :namespace_prefix=>nil, :attributes=>{ :annotationType=>"Color Space" })
+      t.inst_chroma(:path=>"instantiationAnnotation", :namespace_prefix=>nil, :attributes=>{ :annotationType=>"Chroma" })
+
+    }
+
+    #
+    # Here are the actual references to the fields
+    #
+
+    t.name(:proxy=>[:pbcoreInstantiation, :instantiationIdentifier])
+    t.location(:proxy=>[:pbcoreInstantiation, :instantiationLocation])
+    t.date(:proxy=>[:pbcoreInstantiation, :instantiationDate])
+    t.generation(:proxy=>[:pbcoreInstantiation, :instantiationGenerations])
+    t.media_type(:proxy=>[:pbcoreInstantiation, :instantiationMediaType])
+    t.file_format(:proxy=>[:pbcoreInstantiation, :instantiationDigital])
+    t.size(:proxy=>[:pbcoreInstantiation, :instantiationFileSize])
+    t.size_units(:proxy=>[:pbcoreInstantiation, :instantiationFileSize, :units])
+    t.colors(:proxy=>[:pbcoreInstantiation, :instantiationColors])
+    t.duration(:proxy=>[:pbcoreInstantiation, :instantiationDuration])
+    t.rights_summary(:proxy=>[:pbcoreInstantiation, :instantiationRights, :rightsSummary])
+
+    # Proxies to annotation fields and other fields that are not in the template
+    t.note(:proxy=>[:pbcoreInstantiation, :inst_note])
+    t.checksum_type(:proxy=>[:pbcoreInstantiation, :inst_chksum_type])
+    t.checksum_value(:proxy=>[:pbcoreInstantiation, :inst_chksum_value])
+    t.device(:proxy=>[:pbcoreInstantiation, :inst_device])
+    t.capture_soft(:proxy=>[:pbcoreInstantiation, :inst_capture_soft])
+    t.trans_soft(:proxy=>[:pbcoreInstantiation, :inst_trans_soft])
+    t.operator(:proxy=>[:pbcoreInstantiation, :inst_operator])
+    t.trans_note(:proxy=>[:pbcoreInstantiation, :inst_trans_note])
+    t.vendor(:proxy=>[:pbcoreInstantiation, :inst_vendor])
+    t.condition(:proxy=>[:pbcoreInstantiation, :inst_cond_note])
+    t.cleaning(:proxy=>[:pbcoreInstantiation, :inst_clean_note])
+    t.color_space(:proxy=>[:pbcoreInstantiation, :inst_color_space])
+    t.chroma(:proxy=>[:pbcoreInstantiation, :inst_chroma])
+    t.standard(:proxy=>[:pbcoreInstantiation, :instantiationStandard])
+    t.language(:proxy=>[:pbcoreInstantiation, :instantiationLanguage])
+
+    # Proxies to video essence fields
+    t.video_standard(:proxy=>[:pbcoreInstantiation, :video_essence, :essenceTrackStandard])
+    t.video_encoding(:proxy=>[:pbcoreInstantiation, :video_essence, :essenceTrackEncoding])
+    t.video_bit_rate(:proxy=>[:pbcoreInstantiation, :video_essence, :essenceTrackDataRate])
+    t.video_bit_rate_units(:proxy=>[:pbcoreInstantiation, :video_essence, :essenceTrackDataRate, :units])
+    t.frame_rate(:proxy=>[:pbcoreInstantiation, :video_essence, :essenceTrackFrameRate])
+    t.frame_size(:proxy=>[:pbcoreInstantiation, :video_essence, :essenceTrackFrameSize])
+    t.video_bit_depth(:proxy=>[:pbcoreInstantiation, :video_essence, :essenceTrackBitDepth])
+    t.aspect_ratio(:proxy=>[:pbcoreInstantiation, :video_essence, :essenceTrackAspectRatio])
+
+    # Proxies to audio essence fields
+    t.audio_standard(:proxy=>[:pbcoreInstantiation, :audio_essence, :essenceTrackStandard])
+    t.audio_encoding(:proxy=>[:pbcoreInstantiation, :audio_essence, :essenceTrackEncoding])
+    t.audio_bit_rate(:proxy=>[:pbcoreInstantiation, :audio_essence, :essenceTrackDataRate])
+    t.audio_bit_rate_units(:proxy=>[:pbcoreInstantiation, :audio_essence, :essenceTrackDataRate, :units])
+    t.audio_sample_rate(:proxy=>[:pbcoreInstantiation, :audio_essence, :essenceTrackSamplingRate])
+    t.audio_sample_rate_units(:proxy=>[:pbcoreInstantiation, :audio_essence, :essenceTrackSamplingRate, :units])
+    t.audio_bit_depth(:proxy=>[:pbcoreInstantiation, :audio_essence, :essenceTrackBitDepth])
+    t.audio_channels(:proxy=>[:pbcoreInstantiation, :audio_essence, :essenceTrackAnnotation])
+
+    # Proxies to the relation fields
+    t.next_(:proxy=>[:pbcoreInstantiation, :next_inst, :instantiationRelationIdentifier])
+    t.previous_(:proxy=>[:pbcoreInstantiation, :previous_inst, :instantiationRelationIdentifier])
+
+  end
+
+  def self.xml_template
+    builder = Nokogiri::XML::Builder.new do |xml|
+
+      xml.pbcoreDescriptionDocument("xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
+        "xsi:schemaLocation"=>"http://www.pbcore.org/PBCore/PBCoreNamespace.html") {
+
+        # These fields are only added so that this document will be validated.  However, they
+        # shouldn't be used for anything else here because they're in the parent Fedora object
+        xml.pbcoreIdentifier(:annotation=>"PID", :source=>"Rock and Roll Hall of Fame and Museum")
+        xml.pbcoreTitle
+        xml.pbcoreDescription
+
+        xml.pbcoreInstantiation {
+
+          xml.instantiationIdentifier(:annotation=>"Filename", :source=>"Rock and Roll Hall of Fame and Museum")
+          xml.instantiationDate(:dateType=>"created")
+          xml.instantiationDigital(:source=>"EBU file formats")
+          xml.instantiationLocation
+          xml.instantiationMediaType(:source=>"PBCore instantiationMediaType") {
+            xml.text "Moving image"
+          }
+          xml.instantiationGenerations(:source=>"PBCore instantiationGenerations")
+          xml.instantiationFileSize(:unitsOfMeasure=>"")
+          xml.instantiationDuration
+          xml.instantiationColors(:source=>"PBCore instantiationColors") {
+            xml.text "Color"
+          }
+
+          xml.instantiationEssenceTrack {
+            xml.essenceTrackType {
+              xml.text "Video"
+            }
+            xml.essenceTrackStandard
+            xml.essenceTrackEncoding(:source=>"PBCore essenceTrackEncoding")
+            xml.essenceTrackDataRate(:unitsOfMeasure=>"")
+            xml.essenceTrackFrameRate(:unitsOfMeasure=>"fps")
+            xml.essenceTrackBitDepth
+            xml.essenceTrackFrameSize(:source=>"PBCore essenceTrackFrameSize")
+            xml.essenceTrackAspectRatio(:source=>"PBCore essenceTrackAspectRatio")
+          }
+
+          xml.instantiationEssenceTrack {
+            xml.essenceTrackType {
+              xml.text "Audio"
+            }
+            xml.essenceTrackStandard
+            xml.essenceTrackEncoding(:source=>"PBCore essenceTrackEncoding")
+            xml.essenceTrackDataRate(:unitsOfMeasure=>"")
+            xml.essenceTrackSamplingRate(:unitsOfMeasure=>"")
+            xml.essenceTrackBitDepth
+            xml.essenceTrackAnnotation(:annotationType=>"Number of Audio Channels")
+          }
+
+          xml.instantiationRights {
+            xml.rightsSummary
+          }
+
+        }
+
+      }
+
+    end
+    return builder.doc
+  end
+
+end
+end