Class: Rubydora::DigitalObject
- Inherits:
-
Object
- Object
- Rubydora::DigitalObject
- Extended by:
- ActiveModel::Callbacks, Deprecation
- Includes:
- ActiveModel::Dirty, 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, :createdDate => :objCreateDate }
- 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.
-
.find_or_initialize(*args) ⇒ Object
find or initialize a Fedora object.
Instance Method Summary collapse
- #asOfDateTime(asOfDateTime = nil) ⇒ Object
- #asOfDateTime=(val) ⇒ Object
- #audit_trail ⇒ 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_record? ⇒ Boolean
(also: #new?)
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.
- #state=(val) ⇒ 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
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
90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/rubydora/digital_object.rb', line 90 def initialize pid, repository = nil, = {} run_callbacks :initialize do self.pid = pid @repository = repository @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)
74 75 76 77 78 79 |
# File 'lib/rubydora/digital_object.rb', line 74 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
53 54 55 56 57 58 59 60 |
# File 'lib/rubydora/digital_object.rb', line 53 def self.find pid, repository = nil, = {} obj = self.new pid, repository, if obj.new? raise Rubydora::RecordNotFound, "DigitalObject.find called for an object that doesn't exist" end obj end |
.find_or_initialize(*args) ⇒ Object
find or initialize a Fedora object
66 67 68 |
# File 'lib/rubydora/digital_object.rb', line 66 def self.find_or_initialize *args self.new *args end |
Instance Method Details
#asOfDateTime(asOfDateTime = nil) ⇒ Object
122 123 124 125 126 127 128 |
# File 'lib/rubydora/digital_object.rb', line 122 def asOfDateTime asOfDateTime = nil if asOfDateTime == nil return @asOfDateTime end return self.class.new(pid, @repository, @options.merge(:asOfDateTime => asOfDateTime)) end |
#asOfDateTime=(val) ⇒ Object
130 131 132 |
# File 'lib/rubydora/digital_object.rb', line 130 def asOfDateTime= val @asOfDateTime = val end |
#audit_trail ⇒ Object
102 103 104 |
# File 'lib/rubydora/digital_object.rb', line 102 def audit_trail @audit_trail ||= repository.audit_trail(self.pid) end |
#datastreams ⇒ Array<Rubydora::Datastream> Also known as: datastream
List of datastreams
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/rubydora/digital_object.rb', line 152 def datastreams @datastreams ||= begin h = Hash.new { |h,k| h[k] = datastream_object_for(k) } begin = { :pid => pid, :profiles => 'true' } [:asOfDateTime] = asOfDateTime if asOfDateTime datastreams_xml = repository.datastreams() # pre-3.6, the profiles parm will be ignored 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 # post-3.6, full ds profiles will be returned doc.xpath('//access:datastreamProfile', {'access' => "http://www.fedora.info/definitions/1/0/access/"}).each do |ds| # n.b. that the dsID attribute has a different name in the profile response h[ds['dsID']] = datastream_object_for(ds['dsID'], {:profile => ProfileParser.hash_datastream_profile_node(ds)}) end rescue RestClient::ResourceNotFound end h end end |
#delete ⇒ Rubydora::DigitalObject
Purge the object from Fedora
218 219 220 221 222 223 224 225 226 227 228 |
# File 'lib/rubydora/digital_object.rb', line 218 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
180 181 182 |
# File 'lib/rubydora/digital_object.rb', line 180 def fetch dsid datastreams[dsid] end |
#new_record? ⇒ Boolean Also known as: new?
Does this object already exist?
117 118 119 |
# File 'lib/rubydora/digital_object.rb', line 117 def new_record? self.profile.empty? end |
#profile ⇒ Hash
Retrieve the object profile as a hash (and cache it)
136 137 138 139 140 141 |
# File 'lib/rubydora/digital_object.rb', line 136 def profile @profile ||= begin @new = false repository.object_profile(pid, asOfDateTime) end.freeze end |
#repository ⇒ Rubydora::Repository
repository reference from the digital object
232 233 234 |
# File 'lib/rubydora/digital_object.rb', line 232 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 ‘:changed?` datastreams that already exist new datastreams must be directly saved
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 |
# File 'lib/rubydora/digital_object.rb', line 192 def save check_if_read_only mod_time = nil 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 unless p.empty? mod_time = repository.modify_object p.merge(:pid => pid) changed_attributes.clear end end end mod_time = save_datastreams(mod_time) # mod_time will be nil on new objects with no ds changes unless mod_time.nil? self.lastModifiedDate = mod_time changed_attributes.delete 'lastModifiedDate' end self end |
#state=(val) ⇒ Object
42 43 44 45 46 |
# File 'lib/rubydora/digital_object.rb', line 42 def state= val raise ArgumentError, "Allowed values for state are 'I', 'A' and 'D'. You provided '#{val}'" unless ['I', 'A', 'D'].include?(val) state_will_change! unless val == state @state = val end |
#uri ⇒ Object Also known as: fqpid
Return a full uri pid (for use in relations, etc
109 110 111 112 |
# File 'lib/rubydora/digital_object.rb', line 109 def uri return pid if pid =~ /.+\/.+/ "info:fedora/#{pid}" end |
#versions ⇒ Object
143 144 145 146 147 |
# File 'lib/rubydora/digital_object.rb', line 143 def versions repository.versions_for_object(pid).map do |changeDate| self.class.new pid, repository, :asOfDateTime => changeDate end end |