Class: ActiveFedora::SimpleDatastream

Inherits:
NokogiriDatastream show all
Defined in:
lib/active_fedora/simple_datastream.rb

Overview

This class represents a simple xml datastream.

Instance Attribute Summary collapse

Attributes inherited from NokogiriDatastream

#internal_solr_doc

Attributes included from MetadataDatastreamHelper

#xml_loaded

Attributes inherited from Datastream

#digital_object, #dirty, #last_modified

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from NokogiriDatastream

#content=, #find_by_terms, #from_solr, from_xml, #generate_solr_symbol, #get_values, #get_values_from_solr, #has_solr_name?, #is_hierarchical_term_pointer?, #ng_xml, #ng_xml=, #om_term_values, #om_update_values, #term_values, #to_xml, #update_values

Methods included from MetadataDatastreamHelper

#ensure_xml_loaded, included, #serialize!

Methods inherited from Datastream

#add_ds_location, #add_mime_type, #create, #dirty?, from_xml, #initialize, #inspect, #new_object?, #profile_from_hash, #save, #serialize!, #size, #solrize_profile, #to_param, #validate_content_present

Constructor Details

This class inherits a constructor from ActiveFedora::Datastream

Instance Attribute Details

#fields ⇒ Object

TODO this can be removed when Model.find_by_fields_by_solr has been removed.



7
8
9
 
# File 'lib/active_fedora/simple_datastream.rb', line 7

def fields
  @fields
end

Class Method Details

.xml_template ⇒ Object 



73
74
75
 
# File 'lib/active_fedora/simple_datastream.rb', line 73

def self.xml_template
   Nokogiri::XML::Document.parse("<fields/>")
end

Instance Method Details

#field(name, datatype = nil, opts = {}) ⇒ Object

This method generates the various accessor and mutator methods on self for the datastream metadata attributes. each field will have the 2 magic methods:

name=(arg) 
name

‘datatype’ is a datatype, currently :string, :text and :date are supported.

opts is an options hash, which will affect the generation of the xml representation of this datastream.

Currently supported modifiers: For QualifiedDublinCorDatastreams:

:element_attrs =>{:foo=>:bar} -  hash of xml element attributes
:xml_node => :nodename  - The xml node to be used to represent this object (in dcterms namespace)
:encoding=>foo, or encodings_scheme  - causes an xsi:type attribute to be set to 'foo'
:multiple=>true -  mark this field as a multivalue field (on by default)

At some point, these modifiers will be ported up to work for any ActiveFedora::MetadataDatastream.

There is quite a good example of this class in use in spec/examples/oral_history.rb

!! Careful: If you declare two fields that correspond to the same xml node without any qualifiers to differentiate them, you will end up replicating the values in the underlying datastream, resulting in mysterious dubling, quadrupling, etc. whenever you edit the field’s values.



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/active_fedora/simple_datastream.rb', line 45

def field(name, datatype=nil, opts={})
  fields ||= {}
  @fields[name.to_s.to_sym]={:type=>datatype, :values=>[]}.merge(opts)
  # add term to template
  self.class.class_fields << name.to_s
  # add term to terminology
  unless self.class.terminology.has_term?(name.to_sym)
    term = OM::XML::Term.new(name.to_sym, {}, self.class.terminology)
    self.class.terminology.add_term(term)
    term.generate_xpath_queries!
  end
  
end

#to_solr(solr_doc = Hash.new) ⇒ Object

:nodoc:



77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/active_fedora/simple_datastream.rb', line 77

def to_solr(solr_doc = Hash.new) # :nodoc:
  @fields.each do |field_key, field_info|
    next if field_key == :location ## FIXME HYDRA-825
    things = send(field_key)
    if things 
      field_symbol = ActiveFedora::SolrService.solr_name(field_key, field_info[:type])
      things.val.each do |val|    
        ::Solrizer::Extractor.insert_solr_field_value(solr_doc, field_symbol, val )         
      end
    end
  end
  return solr_doc
end

#update_indexed_attributes(params = {}, opts = {}) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/active_fedora/simple_datastream.rb', line 59

def update_indexed_attributes(params={}, opts={})
  # if the params are just keys, not an array, make then into an array.
  new_params = {}
  params.each do |key, val|
    if key.is_a? Array
      new_params[key] = val
    else
      new_params[[key.to_sym]] = val
    end
  end
  super(new_params, opts)
end