hydra-pbcore 2.4.0 → 3.0.0.rc1

data/lib/hydra_pbcore/datastream/deprecated.rb

@@ -1,6 +0,0 @@
-module HydraPbcore::Datastream::Deprecated
-  extend ActiveSupport::Autoload
-  autoload :Document
-  autoload :DigitalDocument
-  autoload :Instantiation
-end

data/lib/hydra_pbcore/datastream/deprecated/digital_document.rb

@@ -1,105 +0,0 @@
-module HydraPbcore::Datastream::Deprecated
-class DigitalDocument < ActiveFedora::NokogiriDatastream
-
-  class_attribute :institution, :relator
-  self.institution = "Rock and Roll Hall of Fame and Museum"
-  self.relator     = "MARC relator terms"
-
-  include HydraPbcore::Methods
-  include HydraPbcore::Templates
-  include HydraPbcore::Conversions
-
-  @terminology = HydraPbcore::Datastream::Deprecated::Document.terminology
-
-  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=>self.institution, :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.pbcoreRelation {
-          xml.pbcoreRelationType(:source=>"PBCore relationType", :ref=>"http://pbcore.org/vocabularies/relationType#is-part-of") {
-            xml.text "Is Part Of"
-          }
-          xml.pbcoreRelationIdentifier(:annotation=>"Archival Collection")
-        }
-        xml.pbcoreRelation {
-          xml.pbcoreRelationType(:source=>"PBCore relationType", :ref=>"http://pbcore.org/vocabularies/relationType#is-part-of") {
-            xml.text "Is Part Of"
-          }
-          xml.pbcoreRelationIdentifier(:annotation=>"Archival Series")
-        }
-        xml.pbcoreRelation {
-          xml.pbcoreRelationType(:source=>"PBCore relationType", :ref=>"http://pbcore.org/vocabularies/relationType#is-part-of") {
-            xml.text "Is Part Of"
-          }
-          xml.pbcoreRelationIdentifier(:annotation=>"Collection Number")
-        }
-        xml.pbcoreRelation {
-          xml.pbcoreRelationType(:source=>"PBCore relationType", :ref=>"http://pbcore.org/vocabularies/relationType#is-part-of") {
-            xml.text "Is Part Of"
-          }
-          xml.pbcoreRelationIdentifier(:annotation=>"Accession Number")
-        }
-        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.pbcoreRightsSummary
-        xml.pbcoreAnnotation(:annotationType=>"Notes")
-
-      }
-
-    end
-    return builder.doc
-  end
-
-  def to_solr(solr_doc = Hash.new)
-    super(solr_doc)
-    solr_doc.merge!({"format" => "Video"})
-
-    # 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")
-    else
-      solr_doc.merge!(:language_facet => "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
-    return solr_doc
-  end
-
-end
-end

data/lib/hydra_pbcore/datastream/deprecated/document.rb

@@ -1,332 +0,0 @@
-module HydraPbcore::Datastream::Deprecated
-class Document < ActiveFedora::NokogiriDatastream
-
-  class_attribute :institution, :relator
-  self.institution = "Rock and Roll Hall of Fame and Museum"
-  self.relator     = "MARC relator terms"
-
-  include HydraPbcore::Methods
-  include HydraPbcore::Templates
-  include HydraPbcore::Conversions
-
-  set_terminology do |t|
-    t.root(:path=>"pbcoreDescriptionDocument")
-
-    t.pbc_id(:path=>"pbcoreIdentifier", 
-      :attributes=>{ :source=>self.institution, :annotation=>"PID" }
-    )
-
-    t.title(:path=>"pbcoreTitle", :attributes=>{ :titleType=>"Main" }, :index_as => [:searchable, :displayable])
-    t.alternative_title(:path=>"pbcoreTitle", :attributes=>{ :titleType=>"Alternative" },
-      :index_as => [:searchable, :displayable]
-    )
-    t.chapter(:path=>"pbcoreTitle", :attributes=>{ :titleType=>"Chapter" }, :index_as => [:searchable, :displayable])
-    t.episode(:path=>"pbcoreTitle", :attributes=>{ :titleType=>"Episode" }, :index_as => [:searchable, :displayable])
-    t.label(:path=>"pbcoreTitle", :attributes=>{ :titleType=>"Label" }, :index_as => [:searchable, :displayable])
-    t.segment(:path=>"pbcoreTitle", :attributes=>{ :titleType=>"Segment" }, :index_as => [:searchable, :displayable])
-    t.subtitle(:path=>"pbcoreTitle", :attributes=>{ :titleType=>"Subtitle" }, :index_as => [:searchable, :displayable])
-    t.track(:path=>"pbcoreTitle", :attributes=>{ :titleType=>"Track" }, :index_as => [:searchable, :displayable])
-    t.translation(:path=>"pbcoreTitle", :attributes=>{ :titleType=>"Translation" }, 
-      :index_as => [:searchable, :displayable]
-    )
-
-    # This is only to display all subjects
-    t.subject(:path=>"pbcoreSubject", :index_as => [:facetable])
-
-    # Individual subject types defined for entry
-    t.lc_subject(:path=>"pbcoreSubject", 
-      :attributes=>{ 
-        :source=>"Library of Congress Subject Headings", 
-        :ref=>"http://id.loc.gov/authorities/subjects.html"
-      },
-      :index_as => [:displayable]
-    )
-    t.lc_name(:path=>"pbcoreSubject",
-      :attributes=>{ :source=>"Library of Congress Name Authority File", :ref=>"http://id.loc.gov/authorities/names" },
-      :index_as => [:displayable]
-    )
-    t.rh_subject(:path=>"pbcoreSubject", 
-      :attributes=>{ :source=>self.institution },
-      :index_as => [:displayable]
-    )
-
-    t.summary(:path=>"pbcoreDescription", 
-      :attributes=>{ 
-        :descriptionType=>"Description",
-        :descriptionTypeSource=>"pbcoreDescription/descriptionType",
-        :descriptionTypeRef=>"http://pbcore.org/vocabularies/pbcoreDescription/descriptionType#description",
-        :annotation=>"Summary"
-        },
-        :index_as => [:searchable, :displayable]
-    )
-
-    t.contents(:path=>"pbcoreDescription", 
-      :attributes=>{ 
-        :descriptionType=>"Table of Contents",
-        :descriptionTypeSource=>"pbcoreDescription/descriptionType",
-        :descriptionTypeRef=>"http://pbcore.org/vocabularies/pbcoreDescription/descriptionType#table-of-contents",
-        :annotation=>"Parts List"
-      },
-      :index_as => [:searchable, :displayable]
-    )
-
-    # This is only to display all genres
-    t.genre(:path=>"pbcoreGenre", :index_as => [:facetable])
-
-    # Individual genre types defined for entry
-    t.getty_genre(:path=>"pbcoreGenre", 
-      :attributes=>{ 
-        :source=>"The Getty Research Institute Art and Architecture Thesaurus",
-        :ref=>"http://www.getty.edu/research/tools/vocabularies/aat/index.html"
-      },
-      :index_as => [:displayable] 
-    )
-    t.lc_genre(:path=>"pbcoreGenre",
-      :attributes=>{
-        :source=>"Library of Congress Genre/Form Terms", 
-        :ref=>"http://id.loc.gov/authorities/genreForms.html"
-      },
-      :index_as => [:displayable]
-    )
-    t.lc_subject_genre(:path=>"pbcoreGenre",
-      :attributes=>{
-        :source=>"Library of Congress Subject Headings",
-        :ref=>"http://id.loc.gov/authorities/subjects.html"
-      },
-      :index_as => [:displayable]    
-    )
-
-
-    # Series field
-    t.pbcoreRelation do
-      t.pbcoreRelationIdentifier(:attributes=>{ :annotation=>"Event Series" })
-    end
-    t.series(:ref=>[:pbcoreRelation, :pbcoreRelationIdentifier], :index_as => [:facetable, :displayable])
-
-    # Terms for time and place
-    t.event_place(:path=>"pbcoreCoverage/coverage", 
-      :attributes => {:annotation=>"Event Place"},
-      :index_as => [:searchable, :displayable]
-    )
-    t.event_date(:path=>"pbcoreCoverage/coverage", 
-      :attributes => {:annotation=>"Event Date"},
-      :index_as => [:not_searchable, :converted_date, :displayable]
-    )
-
-    # Contributor names and roles
-    t.contributor(:path=>"pbcoreContributor") do
-      t.name_(:path=>"contributor")
-      t.role_(:path=>"contributorRole", 
-        :attributes=>{ :source=>self.relator }
-      )
-    end
-    t.contributor_name(:proxy=>[:contributor, :name], :index_as => [:searchable, :facetable])
-    t.contributor_role(:proxy=>[:contributor, :role], :index_as => [:searchable, :displayable])
-
-    # Publisher names and roles
-    t.publisher(:path=>"pbcorePublisher") do
-      t.name_(:path=>"publisher")
-      t.role_(:path=>"publisherRole", :attributes=>{ :source=>"PBCore publisherRole" })
-    end
-    t.publisher_name(:proxy=>[:publisher, :name], :index_as => [:searchable, :facetable])
-    t.publisher_role(:proxy=>[:publisher, :role], :index_as => [:searchable, :displayable])
-
-    t.note(:path=>"pbcoreAnnotation", :atttributes=>{ :annotationType=>"Notes" }, :index_as => [:searchable, :displayable])
-
-    #
-    # pbcoreInstantiation fields for the physical item
-    #
-    t.pbcoreInstantiation do
-      t.instantiationIdentifier(:attributes=>{ 
-        :annotation=>"Barcode", 
-        :source=>self.institution
-      })
-      t.instantiationDate(:attributes=>{ :dateType=>"created" })
-      t.instantiationPhysical(:attributes=>{ :source=>"PBCore instantiationPhysical" })
-      t.instantiationStandard
-      t.instantiationLocation
-      t.instantiationMediaType(:attributes=>{ :source=>"PBCore instantiationMediaType" })
-      t.instantiationGenerations(:attributes=>{ :source=>"PBCore instantiationGenerations" })
-      t.instantiationColors
-      t.instantiationLanguage(:attributes=>{ 
-        :source=>"ISO 639.2", 
-        :ref=>"http://www.loc.gov/standards/iso639-2/php/code_list.php"
-      })
-      t.instantiationRelation do
-        t.arc_collection(:path=>"instantiationRelationIdentifier", 
-          :attributes=>{ :annotation=>"Archival collection" },
-          :index_as => [:searchable, :facetable]
-        )
-        t.arc_series(:path=>"instantiationRelationIdentifier", :attributes=>{ :annotation=>"Archival Series" })
-        t.col_number(:path=>"instantiationRelationIdentifier", :attributes=>{ :annotation=>"Collection Number" })
-        t.acc_number(:path=>"instantiationRelationIdentifier", :attributes=>{ :annotation=>"Accession Number" })
-      end
-      t.instantiationRights do
-        t.rightsSummary
-      end
-      t.inst_cond_note(:path=>"instantiationAnnotation",
-        :attributes=>{ :annotationType=>"Condition Notes"},
-        :index_as => [:searchable, :displayable]
-      )
-      t.inst_clean_note(:path=>"instantiationAnnotation", 
-        :attributes=>{ :annotationType=>"Cleaning Notes" },
-        :index_as => [:searchable, :displayable]
-      )
-    end
-    # Individual field names:
-    t.creation_date(:ref=>[:pbcoreInstantiation, :instantiationDate], :index_as => [:not_searchable, :converted_date, :displayable])
-    t.barcode(:ref=>[:pbcoreInstantiation, :instantiationIdentifier], :index_as => [:searchable, :displayable])
-    t.repository(:ref=>[:pbcoreInstantiation, :instantiationLocation], :index_as => [:searchable, :displayable])
-    t.media_format(:ref=>[:pbcoreInstantiation, :instantiationPhysical], :index_as => [:searchable, :facetable])
-    t.standard(:ref=>[:pbcoreInstantiation, :instantiationStandard], :index_as => [:searchable, :displayable])
-    t.media_type(:ref=>[:pbcoreInstantiation, :instantiationMediaType], :index_as => [:searchable, :displayable])
-    t.generation(:ref=>[:pbcoreInstantiation, :instantiationGenerations], :index_as => [:searchable, :displayable])
-    t.language(:ref=>[:pbcoreInstantiation, :instantiationLanguage], :index_as => [:searchable, :displayable])
-    t.colors(:ref=>[:pbcoreInstantiation, :instantiationColors], :index_as => [:searchable, :displayable])
-    t.collection(
-      :ref=>[:pbcoreInstantiation, :instantiationRelation, :arc_collection], 
-      :index_as => [:facetable]
-    )
-    t.archival_series(
-      :ref=>[:pbcoreInstantiation, :instantiationRelation, :arc_series], 
-      :index_as => [:searchable, :displayable]
-    )
-    t.collection_number(
-      :ref=>[:pbcoreInstantiation, :instantiationRelation, :col_number], 
-      :index_as => [:searchable, :displayable]
-    )
-    t.accession_number(:ref=>[:pbcoreInstantiation, :instantiationRelation, :acc_number],
-      :index_as => [:searchable, :displayable]
-    )
-    t.access(:ref=>[:pbcoreInstantiation, :instantiationRights, :rightsSummary],
-      :index_as => [:searchable, :displayable]
-    )
-    
-    # Inserted terms
-    t.condition_note(:proxy=>[:pbcoreInstantiation, :inst_cond_note])
-    t.cleaning_note(:proxy=>[:pbcoreInstantiation, :inst_clean_note])
-  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=>self.institution, :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=>self.institution)
-          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 = Hash.new)
-    super(solr_doc)
-    solr_doc.merge!({"format" => "Video"})
-
-    # 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")
-    else
-      solr_doc.merge!(:language_facet => "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
-    return solr_doc
-  end
-
-
-end
-end

data/lib/hydra_pbcore/datastream/deprecated/instantiation.rb

@@ -1,263 +0,0 @@
-module HydraPbcore::Datastream::Deprecated
-class Instantiation < ActiveFedora::NokogiriDatastream
-
-  class_attribute :institution
-  self.institution = "Rock and Roll Hall of Fame and Museum"
-
-  include HydraPbcore::Methods
-  include HydraPbcore::Templates
-  include HydraPbcore::Conversions
-
-  # Note: this is not a complete PBCore document, just an instantiation node
-  set_terminology do |t|
-    t.root(:path=>"pbcoreDescriptionDocument")
-
-    t.pbcoreInstantiation do
-
-      t.instantiationIdentifier(
-        :attributes=>{
-          :annotation=>"Filename",
-          :source=>self.institution
-        },
-        :index_as => [:displayable]
-      )
-      t.instantiationDate(:attributes=>{ :dateType=>"created" },
-        :index_as => [:not_searchable, :converted_date, :displayable]
-      )
-      t.instantiationDigital(:attributes=>{ :source=>"EBU file formats" },
-        :index_as => [:searchable, :facetable]
-      )
-      t.instantiationStandard(:index_as => [:displayable])
-      t.instantiationLocation(:index_as => [:displayable])
-      t.instantiationGenerations(:attributes=>{ :source=>"PBCore instantiationGenerations" },
-        :index_as => [:displayable]  
-      )
-      t.instantiationFileSize(:index_as => [:displayable]) do
-        t.units(:path=>{:attribute=>"unitsOfMeasure"}, :index_as => [:displayable])
-      end
-      t.instantiationColors(:attributes=>{ :source=>"PBCore instantiationColors" },
-        :index_as => [:displayable]
-      )
-      t.instantiationMediaType(:attributes=>{ :source=>"PBCore instantiationMediaType" },
-        :index_as => [:facetable]
-      )
-      t.instantiationLanguage(
-        :attributes=>{
-          :source=>"ISO 639.2",
-          :ref=>"http://www.loc.gov/standards/iso639-2/php/code_list.php"
-        },
-        :index_as => [:searchable]
-      )
-      t.instantiationDuration(:index_as => [:displayable])
-
-      t.instantiationRights do
-        t.rightsSummary(:index_as => [:displayable])
-      end
-
-      t.instantiationEssenceTrack do
-        t.essenceTrackStandard(:index_as => [:displayable])
-        t.essenceTrackEncoding( :attributes=>{ :source=>"PBCore essenceTrackEncoding" },
-          :index_as => [:displayable]
-        )
-        t.essenceTrackDataRate(:index_as => [:displayable]) do
-          t.units(:path=>{:attribute=>"unitsOfMeasure"}, :index_as => [:displayable])
-        end
-        t.essenceTrackFrameRate(:attributes=>{ :unitsOfMeasure=>"fps" }, :index_as => [:displayable])
-        t.essenceTrackFrameSize(:attributes=>{ :source=>"PBCore essenceTrackFrameSize" }, :index_as => [:displayable])
-        t.essenceTrackBitDepth(:index_as => [:displayable])
-        t.essenceTrackAspectRatio(:attributes=>{ :source=>"PBCore essenceTrackAspectRatio" },
-          :index_as => [:displayable]
-        )
-        t.essenceTrackSamplingRate(:index_as => [:displayable]) do
-          t.units(:path=>{:attribute=>"unitsOfMeasure"}, :index_as => [:displayable])
-        end
-        t.essenceTrackAnnotation( :attributes=>{ :annotationType=>"Number of Audio Channels" },
-          :index_as => [:displayable]
-        )
-      end
-      t.video_essence(:ref => [:pbcoreInstantiation, :instantiationEssenceTrack],
-        :path=>'instantiationEssenceTrack[essenceTrackType="Video"]'
-      )
-      t.audio_essence(:ref => [:pbcoreInstantiation, :instantiationEssenceTrack],
-        :path=>'instantiationEssenceTrack[essenceTrackType="Audio"]'
-      )
-
-      t.instantiationRelation do
-        t.instantiationRelationIdentifier(:attributes=>{ :source=>self.institution })
-      end
-      # 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"]'
-      )
-      # 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"]'
-      )
-
-      # Instantitation annotiations
-      t.inst_chksum_type(:path=>"instantiationAnnotation", :attributes=>{ :annotationType=>"Checksum Type" },
-        :index_as => [:displayable]
-      )
-      t.inst_chksum_value(:path=>"instantiationAnnotation", :attributes=>{ :annotationType=>"Checksum Value" },
-        :index_as => [:displayable]
-      )
-      t.inst_device(:path=>"instantiationAnnotation", :attributes=>{ :annotationType=>"Playback Device" },
-        :index_as => [:displayable]
-      )
-      t.inst_capture_soft(:path=>"instantiationAnnotation", :attributes=>{ :annotationType=>"Capture Software" },
-        :index_as => [:displayable]
-      )
-      t.inst_trans_soft(:path=>"instantiationAnnotation", :attributes=>{ :annotationType=>"Transcoding Software" },
-        :index_as => [:displayable]
-      )
-      t.inst_operator(:path=>"instantiationAnnotation", :attributes=>{ :annotationType=>"Operator" },
-        :index_as => [:displayable]
-      )
-      t.inst_trans_note(:path=>"instantiationAnnotation", :attributes=>{ :annotationType=>"Transfer Notes" },
-        :index_as => [:displayable]
-      )
-      t.inst_vendor(:path=>"instantiationAnnotation", :attributes=>{ :annotationType=>"Vendor Name" },
-        :index_as => [:displayable]
-      )
-      t.inst_cond_note(:path=>"instantiationAnnotation", :attributes=>{ :annotationType=>"Condition Notes" },
-        :index_as => [:displayable]
-      )
-      t.inst_clean_note(:path=>"instantiationAnnotation", :attributes=>{ :annotationType=>"Cleaning Notes" },
-        :index_as => [:displayable]
-      )
-      t.inst_note(:path=>"instantiationAnnotation", :attributes=>{ :annotationType=>"Notes" },
-        :index_as => [:displayable]
-      )
-      t.inst_color_space(:path=>"instantiationAnnotation", :attributes=>{ :annotationType=>"Color Space" },
-        :index_as => [:displayable]
-      )
-      t.inst_chroma(:path=>"instantiationAnnotation", :attributes=>{ :annotationType=>"Chroma" },
-        :index_as => [:displayable]
-      )
-
-    end
-
-    #
-    # 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=>self.institution)
-        xml.pbcoreTitle
-        xml.pbcoreDescription
-
-        xml.pbcoreInstantiation {
-
-          xml.instantiationIdentifier(:annotation=>"Filename", :source=>self.institution)
-          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