Class: Hydra::Datastream::ModsImage

Inherits:

ActiveFedora::NokogiriDatastream

• Object
• ActiveFedora::NokogiriDatastream
• Hydra::Datastream::ModsImage

Includes:

CommonModsIndexMethods

Defined in:

app/models/hydra/datastream/mods_image.rb

Class Method Summary

• .common_relator_terms ⇒ Object
• .conference_relator_terms ⇒ Object
• .conference_template ⇒ Object

  Generates a new Conference node.

• .dc_relator_terms ⇒ Object
• .full_name_template ⇒ Object
• .organization_relator_terms ⇒ Object
• .organization_template ⇒ Object

  Generates a new Organization node Uses mods:name.

• .person_relator_terms ⇒ Object
• .person_template ⇒ Object

  Generates a new Person node.

• .valid_child_types ⇒ Object
• .xml_template ⇒ Object

  Generates an empty Mods Image (used when you call ModsImage.new without passing in existing xml).

Instance Method Summary

• #insert_contributor(type, opts = {}) ⇒ Object

  Inserts a new contributor (mods:name) into the mods document creates contributors of type :person, :organization, or :conference.

• #remove_contributor(contributor_type, index) ⇒ Object

  Remove the contributor entry identified by @contributor_type and @index.

• #to_solr(solr_doc = Hash.new) ⇒ Object

Methods included from CommonModsIndexMethods

#extract_person_full_names, #extract_person_organizations

Class Method Details

.common_relator_terms ⇒ Object

# File 'app/models/hydra/datastream/mods_image.rb', line 229

def self.common_relator_terms
   {"aut" => "Author",
    "clb" => "Collaborator",
    "com" => "Compiler",
    "ctb" => "Contributor",
    "cre" => "Creator",
    "edt" => "Editor",
    "ill" => "Illustrator",
    "oth" => "Other",
    "trl" => "Translator",
    }
end

.conference_relator_terms ⇒ Object

# File 'app/models/hydra/datastream/mods_image.rb', line 257

def self.conference_relator_terms
  {
    "hst" => "Host"
  }
end

.conference_template ⇒ Object

Generates a new Conference node

# File 'app/models/hydra/datastream/mods_image.rb', line 178

def self.conference_template
  builder = Nokogiri::XML::Builder.new do |xml|
    xml.name(:type=>"conference") {
      xml.namePart
      xml.role {
        xml.roleTerm(:authority=>"marcrelator", :type=>"text")
      }                          
    }
  end
  return builder.doc.root
end

.dc_relator_terms ⇒ Object

# File 'app/models/hydra/datastream/mods_image.rb', line 270

def self.dc_relator_terms
 {"acp" => "Art copyist",
  "act" => "Actor",
  "adp" => "Adapter",
  "aft" => "Author of afterword, colophon, etc.",
  "anl" => "Analyst",
  "anm" => "Animator",
  "ann" => "Annotator",
  "ant" => "Bibliographic antecedent",
  "app" => "Applicant",
  "aqt" => "Author in quotations or text abstracts",
  "arc" => "Architect",
  "ard" => "Artistic director ",
  "arr" => "Arranger",
  "art" => "Artist",
  "asg" => "Assignee",
  "asn" => "Associated name",
  "att" => "Attributed name",
  "auc" => "Auctioneer",
  "aud" => "Author of dialog",
  "aui" => "Author of introduction",
  "aus" => "Author of screenplay",
  "aut" => "Author",
  "bdd" => "Binding designer",
  "bjd" => "Bookjacket designer",
  "bkd" => "Book designer",
  "bkp" => "Book producer",
  "bnd" => "Binder",
  "bpd" => "Bookplate designer",
  "bsl" => "Bookseller",
  "ccp" => "Conceptor",
  "chr" => "Choreographer",
  "clb" => "Collaborator",
  "cli" => "Client",
  "cll" => "Calligrapher",
  "clt" => "Collotyper",
  "cmm" => "Commentator",
  "cmp" => "Composer",
  "cmt" => "Compositor",
  "cng" => "Cinematographer",
  "cnd" => "Conductor",
  "cns" => "Censor",
  "coe" => "Contestant -appellee",
  "col" => "Collector",
  "com" => "Compiler",
  "cos" => "Contestant",
  "cot" => "Contestant -appellant",
  "cov" => "Cover designer",
  "cpc" => "Copyright claimant",
  "cpe" => "Complainant-appellee",
  "cph" => "Copyright holder",
  "cpl" => "Complainant",
  "cpt" => "Complainant-appellant",
  "cre" => "Creator",
  "crp" => "Correspondent",
  "crr" => "Corrector",
  "csl" => "Consultant",
  "csp" => "Consultant to a project",
  "cst" => "Costume designer",
  "ctb" => "Contributor",
  "cte" => "Contestee-appellee",
  "ctg" => "Cartographer",
  "ctr" => "Contractor",
  "cts" => "Contestee",
  "ctt" => "Contestee-appellant",
  "cur" => "Curator",
  "cwt" => "Commentator for written text",
  "dfd" => "Defendant",
  "dfe" => "Defendant-appellee",
  "dft" => "Defendant-appellant",
  "dgg" => "Degree grantor",
  "dis" => "Dissertant",
  "dln" => "Delineator",
  "dnc" => "Dancer",
  "dnr" => "Donor",
  "dpc" => "Depicted",
  "dpt" => "Depositor",
  "drm" => "Draftsman",
  "drt" => "Director",
  "dsr" => "Designer",
  "dst" => "Distributor",
  "dtc" => "Data contributor ",
  "dte" => "Dedicatee",
  "dtm" => "Data manager ",
  "dto" => "Dedicator",
  "dub" => "Dubious author",
  "edt" => "Editor",
  "egr" => "Engraver",
  "elg" => "Electrician ",
  "elt" => "Electrotyper",
  "eng" => "Engineer",
  "etr" => "Etcher",
  "exp" => "Expert",
  "fac" => "Facsimilist",
  "fld" => "Field director ",
  "flm" => "Film editor",
  "fmo" => "Former owner",
  "fpy" => "First party",
  "fnd" => "Funder",
  "frg" => "Forger",
  "gis" => "Geographic information specialist ",
  "grt" => "Graphic technician",
  "hnr" => "Honoree",
  "hst" => "Host",
  "ill" => "Illustrator",
  "ilu" => "Illuminator",
  "ins" => "Inscriber",
  "inv" => "Inventor",
  "itr" => "Instrumentalist",
  "ive" => "Interviewee",
  "ivr" => "Interviewer",
  "lbr" => "Laboratory ",
  "lbt" => "Librettist",
  "ldr" => "Laboratory director ",
  "led" => "Lead",
  "lee" => "Libelee-appellee",
  "lel" => "Libelee",
  "len" => "Lender",
  "let" => "Libelee-appellant",
  "lgd" => "Lighting designer",
  "lie" => "Libelant-appellee",
  "lil" => "Libelant",
  "lit" => "Libelant-appellant",
  "lsa" => "Landscape architect",
  "lse" => "Licensee",
  "lso" => "Licensor",
  "ltg" => "Lithographer",
  "lyr" => "Lyricist",
  "mcp" => "Music copyist",
  "mfr" => "Manufacturer",
  "mdc" => "Metadata contact",
  "mod" => "Moderator",
  "mon" => "Monitor",
  "mrk" => "Markup editor",
  "msd" => "Musical director",
  "mte" => "Metal-engraver",
  "mus" => "Musician",
  "nrt" => "Narrator",
  "opn" => "Opponent",
  "org" => "Originator",
  "orm" => "Organizer of meeting",
  "oth" => "Other",
  "own" => "Owner",
  "pat" => "Patron",
  "pbd" => "Publishing director",
  "pbl" => "Publisher",
  "pdr" => "Project director",
  "pfr" => "Proofreader",
  "pht" => "Photographer",
  "plt" => "Platemaker",
  "pma" => "Permitting agency",
  "pmn" => "Production manager",
  "pop" => "Printer of plates",
  "ppm" => "Papermaker",
  "ppt" => "Puppeteer",
  "prc" => "Process contact",
  "prd" => "Production personnel",
  "prf" => "Performer",
  "prg" => "Programmer",
  "prm" => "Printmaker",
  "pro" => "Producer",
  "prt" => "Printer",
  "pta" => "Patent applicant",
  "pte" => "Plaintiff -appellee",
  "ptf" => "Plaintiff",
  "pth" => "Patent holder",
  "ptt" => "Plaintiff-appellant",
  "rbr" => "Rubricator",
  "rce" => "Recording engineer",
  "rcp" => "Recipient",
  "red" => "Redactor",
  "ren" => "Renderer",
  "res" => "Researcher",
  "rev" => "Reviewer",
  "rps" => "Repository",
  "rpt" => "Reporter",
  "rpy" => "Responsible party",
  "rse" => "Respondent-appellee",
  "rsg" => "Restager",
  "rsp" => "Respondent",
  "rst" => "Respondent-appellant",
  "rth" => "Research team head",
  "rtm" => "Research team member",
  "sad" => "Scientific advisor",
  "sce" => "Scenarist",
  "scl" => "Sculptor",
  "scr" => "Scribe",
  "sds" => "Sound designer",
  "sec" => "Secretary",
  "sgn" => "Signer",
  "sht" => "Supporting host",
  "sng" => "Singer",
  "spk" => "Speaker",
  "spn" => "Sponsor",
  "spy" => "Second party",
  "srv" => "Surveyor",
  "std" => "Set designer",
  "stl" => "Storyteller",
  "stm" => "Stage manager",
  "stn" => "Standards body",
  "str" => "Stereotyper",
  "tcd" => "Technical director",
  "tch" => "Teacher",
  "ths" => "Thesis advisor",
  "trc" => "Transcriber",
  "trl" => "Translator",
  "tyd" => "Type designer",
  "tyg" => "Typographer",
  "vdg" => "Videographer",
  "voc" => "Vocalist",
  "wam" => "Writer of accompanying material",
  "wdc" => "Woodcutter",
  "wde" => "Wood -engraver",
  "wit" => "Witness"}
end

.full_name_template ⇒ Object

# File 'app/models/hydra/datastream/mods_image.rb', line 156

def self.full_name_template
  builder = Nokogiri::XML::Builder.new do |xml|
    xml.full_name(:type => "personal")
  end
  return builder.doc.root
end

.organization_relator_terms ⇒ Object

# File 'app/models/hydra/datastream/mods_image.rb', line 263

def self.organization_relator_terms
  {
    "fnd" => "Funder",
    "hst" => "Host"
  }
end

.organization_template ⇒ Object

Generates a new Organization node Uses mods:name

# File 'app/models/hydra/datastream/mods_image.rb', line 165

def self.organization_template
  builder = Nokogiri::XML::Builder.new do |xml|
    xml.name(:type=>"corporate") {
      xml.namePart
      xml.role {
        xml.roleTerm(:authority=>"marcrelator", :type=>"text")
      }                          
    }
  end
  return builder.doc.root
end

.person_relator_terms ⇒ Object

# File 'app/models/hydra/datastream/mods_image.rb', line 242

def self.person_relator_terms
  {"aut" => "Author",
   "clb" => "Collaborator",
   "com" => "Compiler",
   "cre" => "Creator",
   "ctb" => "Contributor",
   "edt" => "Editor",
   "ill" => "Illustrator",
   "res" => "Researcher",
   "rth" => "Research team head",
   "rtm" => "Research team member",
   "trl" => "Translator"
   }
end

.person_template ⇒ Object

Generates a new Person node

# File 'app/models/hydra/datastream/mods_image.rb', line 142

def self.person_template
  builder = Nokogiri::XML::Builder.new do |xml|
    xml.name(:type=>"personal") {
      xml.namePart(:type=>"family")
      xml.namePart(:type=>"given")
      xml.affiliation
      xml.role {
        xml.roleTerm(:type=>"text")
      }
    }
  end
  return builder.doc.root
end

.valid_child_types ⇒ Object

# File 'app/models/hydra/datastream/mods_image.rb', line 486

def self.valid_child_types
  ["data", "supporting file", "profile", "lorem ipsum", "dolor"]
end

.xml_template ⇒ Object

Generates an empty Mods Image (used when you call ModsImage.new without passing in existing xml)

# File 'app/models/hydra/datastream/mods_image.rb', line 80

def self.xml_template
  builder = Nokogiri::XML::Builder.new do |xml|
    xml.mods(:version=>"3.3", "xmlns:xlink"=>"http://www.w3.org/1999/xlink",
       "xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
       "xmlns"=>"http://www.loc.gov/mods/v3",
       "xsi:schemaLocation"=>"http://www.loc.gov/mods/v3 http://www.loc.gov/standards/mods/v3/mods-3-3.xsd") {
         xml.titleInfo(:lang=>"") {
           xml.title
         }
         xml.name(:type=>"personal") {
           xml.namePart(:type=>"given")
           xml.namePart(:type=>"family")
           xml.affiliation
           xml.role {
             xml.roleTerm(:authority=>"marcrelator", :type=>"text")
           }
         }
         xml.typeOfResource
         xml.genre(:authority=>"marcgt")
         xml.language {
           xml.languageTerm(:authority=>"iso639-2b", :type=>"code")
         }
  # mods:physicaldescription/mods:extent - used for storing file size in human-readable form.
  xml.physicalDescription {
     xml.extent
  }
         xml.abstract
         xml.subject {
           xml.topic
         }
         xml.relatedItem(:type=>"host") {
           xml.titleInfo {
             xml.title
           }
           xml.identifier(:type=>"issn")
           xml.originInfo {
             xml.publisher
             xml.dateIssued
           }
           xml.part {
             xml.detail(:type=>"volume") {
               xml.number
             }
             xml.detail(:type=>"number") {
               xml.number
             }
             xml.extent(:unit=>"pages") {
               xml.start
               xml.end
             }
             xml.date
           }
         }
         xml.location {
           xml.url
         }
    }
  end
  return builder.doc
end

Instance Method Details

#insert_contributor(type, opts = {}) ⇒ Object

Inserts a new contributor (mods:name) into the mods document creates contributors of type :person, :organization, or :conference

# File 'app/models/hydra/datastream/mods_image.rb', line 192

def insert_contributor(type, opts={})
  case type.to_sym 
  when :person
    node = Hydra::Datastream::ModsImage.person_template
    nodeset = self.find_by_terms(:person)
  when :organization
    node = Hydra::Datastream::ModsImage.organization_template
    nodeset = self.find_by_terms(:organization)
  when :conference
    node = Hydra::Datastream::ModsImage.conference_template
    nodeset = self.find_by_terms(:conference)
  else
    ActiveFedora.logger.warn("#{type} is not a valid argument for Hydra::Datastream::ModsImage.insert_contributor")
    node = nil
    index = nil
  end
  
  unless nodeset.nil?
    if nodeset.empty?
      self.ng_xml.root.add_child(node)
      index = 0
    else
      nodeset.after(node)
      index = nodeset.length
    end
    self.dirty = true
  end
  
  return node, index
end

#remove_contributor(contributor_type, index) ⇒ Object

Remove the contributor entry identified by @contributor_type and @index

# File 'app/models/hydra/datastream/mods_image.rb', line 224

def remove_contributor(contributor_type, index)
  self.find_by_terms( {contributor_type.to_sym => index.to_i} ).first.remove
  self.dirty = true
end

#to_solr(solr_doc = Hash.new) ⇒ Object

# File 'app/models/hydra/datastream/mods_image.rb', line 490

def to_solr(solr_doc=Hash.new)
  super(solr_doc)
  solr_doc.merge!(extract_person_full_names)
  solr_doc.merge!(extract_person_organizations)
  solr_doc.merge!(:object_type_facet => "Image")
  solr_doc
end