Class: Rubydora::DigitalObject
- Inherits:
-
Object
- Object
- Rubydora::DigitalObject
- Extended by:
- ActiveModel::Callbacks
- Includes:
- ActiveModel::Dirty, ExtensionParameters, ModelsMixin, RelationshipsMixin
- Defined in:
- lib/rubydora/digital_object.rb
Overview
This class represents a Fedora object and provides helpers for managing attributes, datastreams, and relationships.
Using the extension framework, implementors may provide additional functionality to this base implementation.
Constant Summary collapse
- OBJ_ATTRIBUTES =
mapping object parameters to profile elements
{:state => :objState, :ownerId => :objOwnerId, :label => :objLabel, :logMessage => nil, :lastModifiedDate => :objLastModDate }
- OBJ_DEFAULT_ATTRIBUTES =
{ }
Constants included from RelationshipsMixin
Instance Attribute Summary collapse
-
#pid ⇒ Object
readonly
Returns the value of attribute pid.
Class Method Summary collapse
-
.create(pid, options = {}, repository = nil) ⇒ Object
create a new fedora object (see also DigitalObject#save).
-
.find(pid, repository = nil, options = {}) ⇒ Object
find an existing fedora object TODO: raise an error if the object does not yet exist.
Instance Method Summary collapse
- #asOfDateTime(asOfDateTime = nil) ⇒ Object
- #asOfDateTime=(val) ⇒ Object
-
#datastreams ⇒ Array<Rubydora::Datastream>
(also: #datastream)
List of datastreams.
-
#delete ⇒ Rubydora::DigitalObject
Purge the object from Fedora.
-
#fetch(dsid) ⇒ Object
(also: #[])
provide an hash-like way to access datastreams.
-
#initialize(pid, repository = nil, options = {}) ⇒ DigitalObject
constructor
Initialize a Rubydora::DigitalObject, which may or may not already exist in the data store.
-
#new? ⇒ Boolean
Does this object already exist?.
-
#profile ⇒ Hash
Retrieve the object profile as a hash (and cache it).
-
#repository ⇒ Rubydora::Repository
repository reference from the digital object.
-
#save ⇒ Rubydora::DigitalObject
persist the object to Fedora, either as a new object by modifing the existing object.
-
#uri ⇒ Object
(also: #fqpid)
Return a full uri pid (for use in relations, etc.
- #versions ⇒ Object
Methods included from RelationshipsMixin
#add_relationship, included, #purge_relationship, #relationship, #relationship_changed, #relationships
Methods included from ModelsMixin
Methods included from ExtensionParameters
Constructor Details
#initialize(pid, repository = nil, options = {}) ⇒ DigitalObject
Initialize a Rubydora::DigitalObject, which may or may not already exist in the data store.
Provides ‘after_initialize` callback for extensions
70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/rubydora/digital_object.rb', line 70 def initialize pid, repository = nil, = {} _run_initialize_callbacks do self.pid = pid @repository = repository @new = true @options = .each do |key, value| self.send(:"#{key}=", value) end end end |
Instance Attribute Details
#pid ⇒ Object
Returns the value of attribute pid.
20 21 22 |
# File 'lib/rubydora/digital_object.rb', line 20 def pid @pid end |
Class Method Details
.create(pid, options = {}, repository = nil) ⇒ Object
create a new fedora object (see also DigitalObject#save)
54 55 56 57 58 59 |
# File 'lib/rubydora/digital_object.rb', line 54 def self.create pid, = {}, repository = nil repository ||= Rubydora.repository assigned_pid = repository.ingest(.merge(:pid => pid)) self.new assigned_pid, repository end |
.find(pid, repository = nil, options = {}) ⇒ Object
find an existing fedora object TODO: raise an error if the object does not yet exist
46 47 48 |
# File 'lib/rubydora/digital_object.rb', line 46 def self.find pid, repository = nil, = {} self.new pid, repository, end |
Instance Method Details
#asOfDateTime(asOfDateTime = nil) ⇒ Object
98 99 100 101 102 103 104 |
# File 'lib/rubydora/digital_object.rb', line 98 def asOfDateTime asOfDateTime = nil if asOfDateTime == nil return @asOfDateTime end return self.class.new(pid, @repository, @options.merge(:asOfDateTime => asOfDateTime)) end |
#asOfDateTime=(val) ⇒ Object
106 107 108 |
# File 'lib/rubydora/digital_object.rb', line 106 def asOfDateTime= val @asOfDateTime = val end |
#datastreams ⇒ Array<Rubydora::Datastream> Also known as: datastream
List of datastreams
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/rubydora/digital_object.rb', line 153 def datastreams @datastreams ||= begin h = Hash.new { |h,k| h[k] = datastream_object_for(k) } begin = { :pid => pid } [:asOfDateTime] = asOfDateTime if asOfDateTime datastreams_xml = repository.datastreams() datastreams_xml.gsub! '<objectDatastreams', '<objectDatastreams xmlns="http://www.fedora.info/definitions/1/0/access/"' unless datastreams_xml =~ /xmlns=/ doc = Nokogiri::XML(datastreams_xml) doc.xpath('//access:datastream', {'access' => "http://www.fedora.info/definitions/1/0/access/"}).each do |ds| h[ds['dsid']] = datastream_object_for ds['dsid'] end rescue RestClient::ResourceNotFound end h end end |
#delete ⇒ Rubydora::DigitalObject
Purge the object from Fedora
205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/rubydora/digital_object.rb', line 205 def delete check_if_read_only my_pid = pid run_callbacks :destroy do @datastreams = nil @profile = nil @pid = nil nil end repository.purge_object(:pid => my_pid) ##This can have a meaningful exception, don't put it in the callback end |
#fetch(dsid) ⇒ Object Also known as: []
provide an hash-like way to access datastreams
175 176 177 |
# File 'lib/rubydora/digital_object.rb', line 175 def fetch dsid datastreams[dsid] end |
#new? ⇒ Boolean
Does this object already exist?
93 94 95 96 |
# File 'lib/rubydora/digital_object.rb', line 93 def new? self.profile ### Make sure we've checked the repository at least once @new end |
#profile ⇒ Hash
Retrieve the object profile as a hash (and cache it)
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 |
# File 'lib/rubydora/digital_object.rb', line 112 def profile @profile ||= begin = { :pid => pid } [:asOfDateTime] = asOfDateTime if asOfDateTime profile_xml = repository.object() profile_xml.gsub! '<objectProfile', '<objectProfile xmlns="http://www.fedora.info/definitions/1/0/access/"' unless profile_xml =~ /xmlns=/ doc = Nokogiri::XML(profile_xml) h = doc.xpath('/access:objectProfile/*', {'access' => "http://www.fedora.info/definitions/1/0/access/"} ).inject({}) do |sum, node| sum[node.name] ||= [] sum[node.name] << node.text if node.name == "objModels" sum[node.name] = node.xpath('access:model', {'access' => "http://www.fedora.info/definitions/1/0/access/"}).map { |x| x.text } end sum end h.select { |key, value| value.length == 1 }.each do |key, value| next if key == "objModels" h[key] = value.first end @new = false h rescue Exception => e {} end.freeze end |
#repository ⇒ Rubydora::Repository
repository reference from the digital object
219 220 221 |
# File 'lib/rubydora/digital_object.rb', line 219 def repository @repository ||= Rubydora.repository end |
#save ⇒ Rubydora::DigitalObject
persist the object to Fedora, either as a new object by modifing the existing object
also will save all ‘:dirty?` datastreams that already exist new datastreams must be directly saved
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/rubydora/digital_object.rb', line 187 def save check_if_read_only run_callbacks :save do if self.new? self.pid = repository.ingest to_api_params.merge(:pid => pid) @profile = nil #will cause a reload with updated data else p = to_api_params repository.modify_object p.merge(:pid => pid) unless p.empty? end end self.datastreams.select { |dsid, ds| ds.changed? }.each { |dsid, ds| ds.save } self end |
#uri ⇒ Object Also known as: fqpid
Return a full uri pid (for use in relations, etc
85 86 87 88 |
# File 'lib/rubydora/digital_object.rb', line 85 def uri return pid if pid =~ /.+\/.+/ "info:fedora/#{pid}" end |
#versions ⇒ Object
141 142 143 144 145 146 147 148 |
# File 'lib/rubydora/digital_object.rb', line 141 def versions versions_xml = repository.object_versions(:pid => pid) versions_xml.gsub! '<fedoraObjectHistory', '<fedoraObjectHistory xmlns="http://www.fedora.info/definitions/1/0/access/"' unless versions_xml =~ /xmlns=/ doc = Nokogiri::XML(versions_xml) doc.xpath('//access:objectChangeDate', {'access' => 'http://www.fedora.info/definitions/1/0/access/' } ).map do |changeDate| self.class.new pid, repository, :asOfDateTime => changeDate.text end end |