Module: Dor::Describable

Extended by:
ActiveSupport::Concern
Included in:
AdminPolicyObject, BasicItem, Collection, Publishable, Set
Defined in:
lib/dor/models/describable.rb

Defined Under Namespace

Classes: CrosswalkError

Constant Summary collapse

DESC_MD_FORMATS = 
{
  'http://www.tei-c.org/ns/1.0' => 'tei',
  'http://www.loc.gov/mods/v3'  => 'mods'
}

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.get_collection_title(obj) ⇒ Object 



254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/dor/models/describable.rb', line 254

def self.get_collection_title(obj)
  xml = obj.descMetadata.ng_xml
  title = ''
  title_node = xml.at_xpath('//mods:mods/mods:titleInfo/mods:title','mods' => 'http://www.loc.gov/mods/v3')
  if title_node
    title = title_node.content
    subtitle = xml.at_xpath('//mods:mods/mods:titleInfo/mods:subTitle','mods' => 'http://www.loc.gov/mods/v3')
    title += ' (' + subtitle.content + ')' if subtitle
  end
  title
end

Instance Method Details

#add_access_conditions(doc) ⇒ Object

Note:

this method modifies the passed in doc

Create MODS accessCondition statements from rightsMetadata

Parameters:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/dor/models/describable.rb', line 66

def add_access_conditions(doc)
  # clear out any existing accessConditions
  doc.xpath('//mods:accessCondition', 'mods' => 'http://www.loc.gov/mods/v3').each {|n| n.remove}
  rights = datastreams['rightsMetadata'].ng_xml

  rights.xpath('//use/human[@type="useAndReproduction"]').each do |use|
    txt = use.text.strip
    next if txt.empty?
    new_use = doc.create_element('accessCondition', use.text.strip, :type => 'useAndReproduction')
    doc.root.element_children.last.add_next_sibling new_use
  end
  rights.xpath('//copyright/human[@type="copyright"]').each do |cr|
    txt = cr.text.strip
    next if txt.empty?
    new_use = doc.create_element('accessCondition', txt, :type => 'copyright')
    doc.root.element_children.last.add_next_sibling new_use
  end
  rights.xpath("//use/machine[#{ci_compare('type', 'creativecommons')}]").each do |lic_type|
    next if lic_type.text =~ /none/i
    lic_text = rights.at_xpath("//use/human[#{ci_compare('type', 'creativecommons')}]").text.strip
    next if lic_text.empty?
    new_lic = doc.create_element('accessCondition', "CC #{lic_type.text}: #{lic_text}", :type => 'license')
    doc.root.element_children.last.add_next_sibling new_lic
  end
  rights.xpath("//use/machine[#{ci_compare('type', 'opendatacommons')}]").each do |lic_type|
    next if lic_type.text =~ /none/i
    lic_text = rights.at_xpath("//use/human[#{ci_compare('type', 'opendatacommons')}]").text.strip
    next if lic_text.empty?
    new_lic = doc.create_element('accessCondition', "ODC #{lic_type.text}: #{lic_text}", :type => 'license')
    doc.root.element_children.last.add_next_sibling new_lic
  end
end

#add_collection_reference(doc) ⇒ Object

Note:

this method modifies the passed in doc

returns the desc metadata a relatedItem with information about the collection this object belongs to for use in published mods and mods to DC conversion

Parameters:



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
 
# File 'lib/dor/models/describable.rb', line 102

def add_collection_reference(doc)
  return unless methods.include? :public_relationships
  collections = public_relationships.search('//rdf:RDF/rdf:Description/fedora:isMemberOfCollection',
                                   'fedora' => 'info:fedora/fedora-system:def/relations-external#',
                                   'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#' )
  return if collections.empty?

  # Remove any existing collections in the descMetadata
  doc.search('/mods:mods/mods:relatedItem[@type="host"]/mods:typeOfResource[@collection=\'yes\']', 'mods' => 'http://www.loc.gov/mods/v3').each do |node|
    node.parent.remove
  end

  collections.each do |collection_node|
    druid = collection_node['rdf:resource']
    druid = druid.gsub('info:fedora/','')
    collection_obj = Dor::Item.find(druid)
    collection_title = Dor::Describable.get_collection_title(collection_obj)
    related_item_node = Nokogiri::XML::Node.new('relatedItem', doc)
    related_item_node['type'] = 'host'
    title_info_node = Nokogiri::XML::Node.new('titleInfo', doc)
    title_node = Nokogiri::XML::Node.new('title', doc)
    title_node.content = collection_title

    # e.g., 
    #   <location>
    #     <url>http://purl.stanford.edu/rh056sr3313</url>
    #   </location>
    loc_node = doc.create_element('location')
    url_node = doc.create_element('url')
    url_node.content = "http://#{Dor::Config.stacks.document_cache_host}/#{druid.split(':').last}"
    loc_node << url_node

    type_node = Nokogiri::XML::Node.new('typeOfResource', doc)
    type_node['collection'] = 'yes'
    doc.root.add_child(related_item_node)
    related_item_node.add_child(title_info_node)
    title_info_node.add_child(title_node)
    related_item_node.add_child(loc_node)
    related_item_node.add_child(type_node)
  end
end

#add_constituent_relations(doc) ⇒ Object

expand constituent relations into relatedItem references – see JUMBO-18

Parameters:

  • doc (Nokogiri::XML) —

    public MODS XML being built



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/dor/models/describable.rb', line 146

def add_constituent_relations(doc)
 self.public_relationships.search('//rdf:RDF/rdf:Description/fedora:isConstituentOf',
                                  'fedora' => 'info:fedora/fedora-system:def/relations-external#',
                                  'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#' ).each do |parent|
    # fetch the parent object to get title
    druid = parent['rdf:resource'].gsub(/^info:fedora\//, '')
    parent_item = Dor::Item.find(druid)

    # create the MODS relation
    relatedItem = doc.create_element 'relatedItem'
    relatedItem['type'] = 'host'
    relatedItem['displayLabel'] = 'Appears in'
    
    # load the title from the parent's DC.title
    titleInfo = doc.create_element 'titleInfo'
    title = doc.create_element 'title'
    title.content = parent_item.datastreams['DC'].title.first
    titleInfo << title
    relatedItem << titleInfo
    
    # point to the PURL for the parent
    location = doc.create_element 'location'
    url = doc.create_element 'url'
    url.content = "http://#{Dor::Config.stacks.document_cache_host}/#{druid.split(':').last}"
    location << url
    relatedItem << location
    
    # finish up by adding relation to public MODS
    doc.root << relatedItem
  end
end

#add_identifier(type, value) ⇒ Object 



218
219
220
221
222
223
224
225
226
 
# File 'lib/dor/models/describable.rb', line 218

def add_identifier(type, value)
  ds_xml = descMetadata.ng_xml
  ds_xml.search('//mods:mods','mods' => 'http://www.loc.gov/mods/v3').each do |node|
    new_node = Nokogiri::XML::Node.new('identifier', ds_xml) # this ends up being mods:identifier without having to specify the namespace
    new_node['type'] = type
    new_node.content = value
    node.add_child(new_node)
  end
end

#build_descMetadata_datastream(ds) ⇒ Object 



22
23
24
25
26
27
28
29
30
 
# File 'lib/dor/models/describable.rb', line 22

def build_descMetadata_datastream(ds)
  content = fetch_descMetadata_datastream
  unless content.nil?
    ds.dsLabel = 'Descriptive Metadata'
    ds.ng_xml = Nokogiri::XML(content)
    ds.ng_xml.normalize_text!
    ds.content = ds.ng_xml.to_xml
  end
end

#delete_identifier(type, value = nil) ⇒ Object 



228
229
230
231
232
233
234
235
236
 
# File 'lib/dor/models/describable.rb', line 228

def delete_identifier(type, value = nil)
  descMetadata.ng_xml.search('//mods:identifier','mods' => 'http://www.loc.gov/mods/v3').each do |node|
    if node.content == value || value.nil?
      node.remove
      return true
    end
  end
  false
end

#fetch_descMetadata_datastream ⇒ Object 



15
16
17
18
19
20
 
# File 'lib/dor/models/describable.rb', line 15

def fetch_descMetadata_datastream
  candidates = datastreams['identityMetadata'].otherId.collect { |oid| oid.to_s }
  metadata_id = Dor::MetadataService.resolvable(candidates).first
  return nil if metadata_id.nil?
  Dor::MetadataService.fetch(metadata_id.to_s)
end

#generate_dublin_core ⇒ Object

Generates Dublin Core from the MODS in the descMetadata datastream using the LoC mods2dc stylesheet Should NOT be used for the Fedora DC datastream

Raises:

  • (Exception) —

    Raises an Exception if the generated DC is empty or has no children



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/dor/models/describable.rb', line 35

def generate_dublin_core
  format = metadata_format
  if format.nil?
    raise CrosswalkError, "Unknown descMetadata namespace: #{metadata_namespace.inspect}"
  end
  xslt = Nokogiri::XSLT(File.new(File.expand_path(File.dirname(__FILE__) + "/#{format}2dc.xslt")) )
  desc_md = descMetadata.ng_xml.dup(1)
  add_collection_reference(desc_md)
  dc_doc = xslt.transform(desc_md)
  # Remove empty nodes
  dc_doc.xpath('/oai_dc:dc/*[count(text()) = 0]').remove
  if dc_doc.root.nil? || dc_doc.root.children.size == 0
    raise CrosswalkError, "Dor::Item#generate_dublin_core produced incorrect xml:\n#{dc_doc.to_xml}"
  end
  dc_doc
end

#generate_public_desc_md ⇒ Object 



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/dor/models/describable.rb', line 52

def generate_public_desc_md
  doc = descMetadata.ng_xml.dup(1)
  add_collection_reference(doc)
  add_access_conditions(doc)
  add_constituent_relations(doc)
  doc.xpath('//comment()').remove
  new_doc = Nokogiri::XML(doc.to_xml) { |x| x.noblanks }
  new_doc.encoding = 'UTF-8'
  new_doc.to_xml
end

#metadata_format ⇒ Object 



184
185
186
 
# File 'lib/dor/models/describable.rb', line 184

def metadata_format
  DESC_MD_FORMATS[metadata_namespace]
end

#metadata_namespace ⇒ Object 



178
179
180
181
182
 
# File 'lib/dor/models/describable.rb', line 178

def metadata_namespace
  desc_md = datastreams['descMetadata'].ng_xml
  return nil if desc_md.nil? || desc_md.root.nil? || desc_md.root.namespace.nil?
  desc_md.root.namespace.href
end

#set_desc_metadata_using_label(force = false) ⇒ Object 



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/dor/models/describable.rb', line 238

def set_desc_metadata_using_label(force = false)
  ds = descMetadata
  unless force || ds.new?
    raise 'Cannot proceed, there is already content in the descriptive metadata datastream.' + ds.content.to_s
  end
  label = self.label
  builder = Nokogiri::XML::Builder.new { |xml|
    xml.mods( 'xmlns' => 'http://www.loc.gov/mods/v3', 'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance', :version => '3.3', "xsi:schemaLocation" => 'http://www.loc.gov/mods/v3 http://www.loc.gov/standards/mods/v3/mods-3-3.xsd'){
      xml.titleInfo{
        xml.title label
      }
    }
  }
  descMetadata.content=builder.to_xml
end

#to_solr(solr_doc = {}, *args) ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/dor/models/describable.rb', line 188

def to_solr(solr_doc = {}, *args)
  super solr_doc, *args
  add_solr_value(solr_doc, 'metadata_format', metadata_format, :string, [:searchable, :facetable])
  begin
    dc_doc = generate_dublin_core
    dc_doc.xpath('/oai_dc:dc/*').each do |node|
      add_solr_value(solr_doc, "public_dc_#{node.name}", node.text, :string, [:searchable])
    end
    creator = ''
    dc_doc.xpath('//dc:creator').each do |node|
      creator = node.text
    end
    title = ''
    dc_doc.xpath('//dc:title').each do |node|
      title = node.text
    end
    creator_title = creator+title
    add_solr_value(solr_doc, 'creator_title', creator_title, :string, [:sortable])
  rescue CrosswalkError => e
    ActiveFedora.logger.warn "Cannot index #{pid}.descMetadata: #{e.message}"
  end
  solr_doc
end

#update_title(new_title) ⇒ Object 



212
213
214
215
216
 
# File 'lib/dor/models/describable.rb', line 212

def update_title(new_title)
  unless update_simple_field('mods:mods/mods:titleInfo/mods:title', new_title)
    raise 'Descriptive metadata has no title to update!'
  end
end