Class: Hydra::ModsArticleDatastream

Inherits:
ActiveFedora::NokogiriDatastream show all
Defined in:
lib/active_fedora/samples/hydra-mods_article_datastream.rb

Overview

This is an example of a NokogiriDatastream that defines an OM terminology for MODS xml It focuses on the aspects of MODS that deal with descriptive metadata for published articles This is not the hydra-head plugin version of this OM Terminology; See github.com/projecthydra/hydra-head/blob/master/lib/hydra/mods_article.rb

Things to note about the OM Terminology defined here:

  • Uses :ref terms to repeat the structures of a mods:name with a different @type on the mods:name element

  • Defines a term lang_code that maps to “languageTerm”

  • Defines a variety of terms, date, last_name, first_name & terms_of_address, that all map to mods:namePart but use varying attributes to distinguish themselves

  • Uses proxy terms to define familar terms like start_page and end_page that map to non-intuitive xml structures “extent/start” and “extent/end”

  • Uses proxy terms, publication_url, peer_reviewed, and title, to allow convenient access to frequently used terms

Things to note about the additional methods it defines:

  • Defines a series of templates, person_template, organization_template, etc. for generating a whole set of xml nodes to insert into the document (note: the new OM::TemplateRegistry provides an even better way to do this)

  • Defines a custom method, insert_contributor, that uses the Terminology to manipulate xml documents in specialized ways

  • Defines a series of relator_term Hashes that can then be used when generating views, etc. In this case, the Hashes are hard-coded into the Class. Ideally, they might be read from a configuration file or mixed into the class using a module

Instance Attribute Summary

Attributes inherited from ActiveFedora::NokogiriDatastream

#internal_solr_doc, #ng_xml

Attributes included from ActiveFedora::MetadataDatastreamHelper

#fields

Attributes inherited from ActiveFedora::Datastream

#dirty, #fields, #last_modified

Attributes inherited from Fedora::BaseObject

#attributes, #blob, #errors, #new_object, #uri

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ActiveFedora::NokogiriDatastream

#from_solr, from_xml, #generate_solr_symbol, #get_values, #get_values_from_solr, #has_solr_name?, #initialize, #is_hierarchical_term_pointer?, #om_term_values, #om_update_values, #term_values, #to_xml, #update_indexed_attributes, #update_values

Methods included from ActiveFedora::MetadataDatastreamHelper

#from_solr, included, #initialize, #save, #set_blob_for_save, #to_xml

Methods inherited from ActiveFedora::Datastream

#after_save, #before_save, #check_concurrency, #content, #content=, delete, #delete, #dirty?, #dsid=, from_xml, #initialize, #last_modified_in_repository, #pid, #pid=, #save, #size, #to_param

Methods inherited from Fedora::Datastream

#control_group, #control_group=, #dsid, #initialize, #label, #label=, #mime_type, #mime_type=, #pid, #uri, #url

Methods inherited from Fedora::BaseObject

#[], #initialize, #new_object?

Constructor Details

This class inherits a constructor from ActiveFedora::NokogiriDatastream

Class Method Details

.common_relator_terms ⇒ Object 



247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/active_fedora/samples/hydra-mods_article_datastream.rb', line 247

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 



275
276
277
278
279
 
# File 'lib/active_fedora/samples/hydra-mods_article_datastream.rb', line 275

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

.conference_template ⇒ Object

Generates a new Conference node



196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/active_fedora/samples/hydra-mods_article_datastream.rb', line 196

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 



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/active_fedora/samples/hydra-mods_article_datastream.rb', line 288

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 



174
175
176
177
178
179
 
# File 'lib/active_fedora/samples/hydra-mods_article_datastream.rb', line 174

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 



281
282
283
284
285
286
 
# File 'lib/active_fedora/samples/hydra-mods_article_datastream.rb', line 281

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

.organization_template ⇒ Object

Generates a new Organization node Uses mods:name



183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/active_fedora/samples/hydra-mods_article_datastream.rb', line 183

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 



260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/active_fedora/samples/hydra-mods_article_datastream.rb', line 260

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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/active_fedora/samples/hydra-mods_article_datastream.rb', line 158

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.computing_id
      xml.description
      xml.role {
        xml.roleTerm("Author", :type=>"text")
      }
    }
  end
  return builder.doc.root
end

.valid_child_types ⇒ Object 



504
505
506
 
# File 'lib/active_fedora/samples/hydra-mods_article_datastream.rb', line 504

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

.xml_template ⇒ Object

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/active_fedora/samples/hydra-mods_article_datastream.rb', line 97

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.computing_id
           xml.description
           xml.role {
             xml.roleTerm("Author", :authority=>"marcrelator", :type=>"text")
           }
         }
         xml.typeOfResource
         xml.genre(:authority=>"marcgt")
         xml.language {
           xml.languageTerm(:authority=>"iso639-2b", :type=>"code")
         }
         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.issuance
           }
           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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/active_fedora/samples/hydra-mods_article_datastream.rb', line 210

def insert_contributor(type, opts={})
  case type.to_sym 
  when :person
    node = Hydra::ModsArticleDatastream.person_template
    nodeset = self.find_by_terms(:person)
  when :organization
    node = Hydra::ModsArticleDatastream.organization_template
    nodeset = self.find_by_terms(:organization)
  when :conference
    node = Hydra::ModsArticleDatastream.conference_template
    nodeset = self.find_by_terms(:conference)
  else
    ActiveFedora.logger.warn("#{type} is not a valid argument for Hydra::ModsArticleDatastream.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



242
243
244
245
 
# File 'lib/active_fedora/samples/hydra-mods_article_datastream.rb', line 242

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 



508
509
510
511
512
513
514
515
 
# File 'lib/active_fedora/samples/hydra-mods_article_datastream.rb', line 508

def to_solr(solr_doc=Hash.new)
  super(solr_doc)
        
  ::Solrizer::Extractor.insert_solr_field_value(solr_doc, "object_type_facet", "Article")
  ::Solrizer::Extractor.insert_solr_field_value(solr_doc, "mods_journal_title_info_facet", "Unknown") if solr_doc["mods_journal_title_info_facet"].nil? 

  solr_doc
end