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
-
#add_access_conditions(doc) ⇒ Object
Create MODS accessCondition statements from rightsMetadata.
-
#add_collection_reference(doc) ⇒ Object
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.
- #add_identifier(type, value) ⇒ Object
- #build_descMetadata_datastream(ds) ⇒ Object
- #delete_identifier(type, value = nil) ⇒ Object
- #fetch_descMetadata_datastream ⇒ Object
-
#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.
- #generate_public_desc_md ⇒ Object
- #metadata_format ⇒ Object
- #metadata_namespace ⇒ Object
- #set_desc_metadata_using_label(force = false) ⇒ Object
- #to_solr(solr_doc = Hash.new, *args) ⇒ Object
- #update_title(new_title) ⇒ Object
Class Method Details
.get_collection_title(obj) ⇒ Object
219 220 221 222 223 224 225 226 227 228 229 230 231 |
# File 'lib/dor/models/describable.rb', line 219 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') if(subtitle) title += ' (' + subtitle.content + ')' end end title end |
Instance Method Details
#add_access_conditions(doc) ⇒ Object
this method modifies the passed in doc
Create MODS accessCondition statements from rightsMetadata
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 98 99 100 |
# File 'lib/dor/models/describable.rb', line 67 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 = self.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", cr.text.strip, :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_text = "CC #{lic_type.text}: #{lic_text}" new_lic = doc.create_element("accessCondition", new_text, :type => 'license') doc.root.element_children.last.add_next_sibling new_lic end rights.xpath("//use/machine[#{ci_compare('type', 'opendata')}]").each do |lic_type| next if lic_type.text =~ /none/i lic_text = rights.at_xpath("//use/human[#{ci_compare('type', 'opendata')}]").text.strip next if lic_text.empty? new_text = "ODC #{lic_type.text}: #{lic_text}" new_lic = doc.create_element("accessCondition", new_text, :type => 'license') doc.root.element_children.last.add_next_sibling new_lic end end |
#add_collection_reference(doc) ⇒ Object
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
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 |
# File 'lib/dor/models/describable.rb', line 105 def add_collection_reference(doc) return unless self.methods.include? :public_relationships collections=self.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) =Nokogiri::XML::Node.new('relatedItem',doc) ['type']='host' title_info_node=Nokogiri::XML::Node.new('titleInfo',doc) title_node=Nokogiri::XML::Node.new('title',doc) title_node.content=collection_title id_node=Nokogiri::XML::Node.new('identifier',doc) id_node['type'] = 'uri' id_node.content = "http://#{Dor::Config.stacks.document_cache_host}/#{druid.split(':').last}" type_node=Nokogiri::XML::Node.new('typeOfResource',doc) type_node['collection'] = 'yes' doc.root.add_child() .add_child(title_info_node) title_info_node.add_child(title_node) .add_child(id_node) .add_child(type_node) end end |
#add_identifier(type, value) ⇒ Object
182 183 184 185 186 187 188 189 190 |
# File 'lib/dor/models/describable.rb', line 182 def add_identifier(type, value) ds_xml=self.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
25 26 27 28 29 30 31 32 33 |
# File 'lib/dor/models/describable.rb', line 25 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
191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/dor/models/describable.rb', line 191 def delete_identifier(type,value=nil) ds_xml=self.descMetadata.ng_xml ds_xml.search('//mods:identifier','mods' => 'http://www.loc.gov/mods/v3').each do |node| if node.content == value or value==nil node.remove return true end end return false end |
#fetch_descMetadata_datastream ⇒ Object
15 16 17 18 19 20 21 22 23 |
# File 'lib/dor/models/describable.rb', line 15 def fetch_descMetadata_datastream candidates = self.datastreams['identityMetadata'].otherId.collect { |oid| oid.to_s } = Dor::MetadataService.resolvable(candidates).first unless .nil? return Dor::MetadataService.fetch(.to_s) else return nil end 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
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
# File 'lib/dor/models/describable.rb', line 38 def generate_dublin_core format = self. if format.nil? raise CrosswalkError, "Unknown descMetadata namespace: #{.inspect}" end xslt = Nokogiri::XSLT(File.new(File.(File.dirname(__FILE__) + "/#{format}2dc.xslt")) ) desc_md = self.descMetadata.ng_xml.dup(1) self.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
55 56 57 58 59 60 61 62 |
# File 'lib/dor/models/describable.rb', line 55 def generate_public_desc_md doc = self.descMetadata.ng_xml.dup(1) add_collection_reference(doc) add_access_conditions(doc) new_doc = Nokogiri::XML(doc.to_xml) { |x| x.noblanks } new_doc.encoding = 'UTF-8' new_doc.to_xml end |
#metadata_format ⇒ Object
150 151 152 |
# File 'lib/dor/models/describable.rb', line 150 def DESC_MD_FORMATS[] end |
#metadata_namespace ⇒ Object
141 142 143 144 145 146 147 148 |
# File 'lib/dor/models/describable.rb', line 141 def desc_md = self.datastreams['descMetadata'].ng_xml if desc_md.nil? or desc_md.root.nil? or desc_md.root.namespace.nil? return nil else return desc_md.root.namespace.href end end |
#set_desc_metadata_using_label(force = false) ⇒ Object
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'lib/dor/models/describable.rb', line 203 def (force=false) ds=self.descMetadata unless force or ds.new?#22 is the length of <?xml version="1.0"?> 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 } } } self.descMetadata.content=builder.to_xml end |
#to_solr(solr_doc = Hash.new, *args) ⇒ Object
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 154 def to_solr(solr_doc=Hash.new, *args) super solr_doc, *args add_solr_value(solr_doc, "metadata_format", self., :string, [:searchable, :facetable]) begin dc_doc = self.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 #{self.pid}.descMetadata: #{e.}" end solr_doc end |
#update_title(new_title) ⇒ Object
177 178 179 180 181 |
# File 'lib/dor/models/describable.rb', line 177 def update_title(new_title) if not update_simple_field('mods:mods/mods:titleInfo/mods:title',new_title) raise 'Descriptive metadata has no title to update!' end end |