Class: Dor::EmbargoMetadataDS

Inherits:
ActiveFedora::OmDatastream
  • Object
show all
Defined in:
lib/dor/datastreams/embargo_metadata_ds.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.xml_template ⇒ Object

Default EmbargoMetadataDS xml



18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/dor/datastreams/embargo_metadata_ds.rb', line 18

def self.xml_template
  builder = Nokogiri::XML::Builder.new do |xml|
    xml.embargoMetadata {
      xml.status
      xml.releaseDate
      xml.releaseAccess
      xml.twentyPctVisibilityStatus
      xml.twentyPctVisibilityReleaseDate
    }
  end
  builder.doc
end

Instance Method Details

#ensure_non_versionable ⇒ Object 



41
42
43
 
# File 'lib/dor/datastreams/embargo_metadata_ds.rb', line 41

def ensure_non_versionable
  self.versionable = 'false'
end

#prefix ⇒ Object

maintain AF < 8 indexing behavior



110
111
112
 
# File 'lib/dor/datastreams/embargo_metadata_ds.rb', line 110

def prefix
  ''
end

#release_access_node ⇒ Nokogiri::XML::Element

Returns The releaseAccess node.

Returns:

  • (Nokogiri::XML::Element) —

    The releaseAccess node



93
94
95
 
# File 'lib/dor/datastreams/embargo_metadata_ds.rb', line 93

def release_access_node
  find_by_terms(:release_access).first
end

#release_access_node=(new_doc) ⇒ Object

Sets the embargaAccess node

Parameters:



99
100
101
102
103
104
105
106
107
 
# File 'lib/dor/datastreams/embargo_metadata_ds.rb', line 99

def release_access_node=(new_doc)
  if new_doc.root.name != 'releaseAccess'
    raise 'Trying to replace releaseAccess with a non-releaseAccess document'
  end

  term_value_delete(:select => '//embargoMetadata/releaseAccess')
  ng_xml_will_change!
  ng_xml.root.add_child(new_doc.root.clone)
end

#release_date ⇒ Time

Current releaseDate value

Returns:

  • (Time) 


66
67
68
69
 
# File 'lib/dor/datastreams/embargo_metadata_ds.rb', line 66

def release_date
  rd = term_values(:release_date).first
  (rd.nil? || rd.empty?) ? nil : Time.parse(rd)
end

#release_date=(rd = Time.now.utc) ⇒ Object

Sets the release date. Does NOT convert to beginning-of-day.

Parameters:

  • rd (Time) (defaults to: Time.now.utc) —

    the release date object



60
61
62
 
# File 'lib/dor/datastreams/embargo_metadata_ds.rb', line 60

def release_date=(rd = Time.now.utc)
  update_values([:release_date] => rd.utc.xmlschema)
end

#status ⇒ Object 



54
55
56
 
# File 'lib/dor/datastreams/embargo_metadata_ds.rb', line 54

def status
  term_values(:status).first
end

#status=(new_status) ⇒ Object

Convenience methods to get and set embargo properties Hides complexity/verbosity of OM TermOperators for simple, non-repeating values



50
51
52
 
# File 'lib/dor/datastreams/embargo_metadata_ds.rb', line 50

def status=(new_status)
  update_values([:status] => new_status)
end

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



31
32
33
34
35
36
37
38
39
 
# File 'lib/dor/datastreams/embargo_metadata_ds.rb', line 31

def to_solr(solr_doc = {}, *args)
  solr_doc = super
  #::Solrizer.insert_field(solr_doc, field_name, value, *index_types)
  rd1  = release_date
  rd20 = twenty_pct_release_date
  ::Solrizer.insert_field(solr_doc, 'embargo_release', rd1.utc.strftime('%FT%TZ'), :dateable) unless rd1.blank?
  ::Solrizer.insert_field(solr_doc, 'twenty_pct_visibility_release', rd20.utc.strftime('%FT%TZ'), :dateable) unless rd20.blank?
  solr_doc
end

#twenty_pct_release_date ⇒ Time

Current twentyPctVisibilityReleaseDate value

Returns:

  • (Time) 


87
88
89
90
 
# File 'lib/dor/datastreams/embargo_metadata_ds.rb', line 87

def twenty_pct_release_date
  rd = term_values(:twenty_pct_release_date).first
  (rd.nil? || rd.empty?) ? nil : Time.parse(rd)
end

#twenty_pct_release_date=(rd = Time.now.utc) ⇒ Object

Sets the 20% visibility release date. Converts the date to beginning-of-day, UTC to help with Solr indexing

Parameters:

  • rd (Time) (defaults to: Time.now.utc) —

    A Time object represeting the release date. By default, it is set to now



81
82
83
 
# File 'lib/dor/datastreams/embargo_metadata_ds.rb', line 81

def twenty_pct_release_date=(rd = Time.now.utc)
  update_values([:twenty_pct_release_date] => rd.beginning_of_day.utc.xmlschema)
end

#twenty_pct_status ⇒ Object 



75
76
77
 
# File 'lib/dor/datastreams/embargo_metadata_ds.rb', line 75

def twenty_pct_status
  term_values(:twenty_pct_status).first
end

#twenty_pct_status=(new_status) ⇒ Object 



71
72
73
 
# File 'lib/dor/datastreams/embargo_metadata_ds.rb', line 71

def twenty_pct_status=(new_status)
  update_values([:twenty_pct_status] => new_status)
end