Class: ActiveFedora::RDFDatastream

Inherits:
File
  • Object
show all
Includes:
ActiveFedora::RDF::DatastreamIndexing, ActiveTriples::NestedAttributes, ActiveTriples::Properties, ActiveTriples::Reflection
Defined in:
lib/active_fedora/rdf/rdf_datastream.rb

Direct Known Subclasses

NtriplesRDFDatastream, RDFXMLDatastream

Constant Summary

Constant Summary

Constants included from AttributeMethods

AttributeMethods::AttrNames

Instance Attribute Summary

Attributes inherited from File

#mime_type

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ActiveFedora::RDF::DatastreamIndexing

#primary_solr_name, #to_solr

Methods inherited from File

#attribute_will_change!, #changed?, #check_fixity, #datastream_will_change!, #default_attributes, default_attributes, #default_attributes=, #described_by, #digest, #dirty_size, #empty?, #exists!, #frozen?, #has_content?, #initialize, #inspect, #ldp_connection, #ldp_source, #metadata, #new_record?, #original_name, #original_name=, #persisted_size, #reload, #remote_content, #reset, #serialize!, #size, #to_solr, #uri

Methods included from Versionable

#create_version, #has_versions?, #model_type, #restore_version, #versions

Methods included from File::Streaming

#authorization_key, #headers, #stream

Methods included from File::Persistence

#retrieve_content, #save

Methods included from AttributeMethods

#[], #[]=, #attribute_names, #attributes

Constructor Details

This class inherits a constructor from ActiveFedora::File

Class Method Details

.parent_uri(ds) ⇒ Object

Trim the last segment off the URI to get the parents uri



20
21
22
23
24
25
26
27
# File 'lib/active_fedora/rdf/rdf_datastream.rb', line 20

def parent_uri(ds)
  m = /^(.*)\/[^\/]*$/.match(ds.uri)
  if m
    m[1]
  else
    ::RDF::URI.new(nil)
  end
end

.rdf_subject(&block) ⇒ Object



11
12
13
14
15
16
17
# File 'lib/active_fedora/rdf/rdf_datastream.rb', line 11

def rdf_subject &block
  if block_given?
    return @subject_block = block
  end

  @subject_block ||= lambda { |ds| parent_uri(ds) }
end

.resource_class(klass = nil) ⇒ Class

ActiveTriples::Resource and include ActiveFedora::RDF::Persistence.

Parameters:

  • an (Class)

    object to set as the resource class, Must be a descendant of

Returns:

  • (Class)

    the object resource class



34
35
36
37
38
39
40
41
42
43
44
45
# File 'lib/active_fedora/rdf/rdf_datastream.rb', line 34

def resource_class(klass=nil)
  if klass
    raise ArgumentError, "#{self} already has a resource_class #{@resource_class}, cannot redefine it to #{klass}" if @resource_class and klass != @resource_class
    raise ArgumentError, "#{klass} must be a subclass of ActiveTriples::Resource" unless klass < ActiveTriples::Resource
  end

  @resource_class ||= begin
                        klass = Class.new(klass || ActiveTriples::Resource)
                        klass.send(:include, RDF::Persistence)
                        klass
                      end
end

Instance Method Details

#contentObject



63
64
65
# File 'lib/active_fedora/rdf/rdf_datastream.rb', line 63

def content
  serialize
end

#content=(new_content) ⇒ Object



67
68
69
70
71
# File 'lib/active_fedora/rdf/rdf_datastream.rb', line 67

def content=(new_content)
  resource.clear!
  resource << deserialize(new_content)
  content
end

#content_changed?Boolean

Returns:

  • (Boolean)


78
79
80
81
82
83
# File 'lib/active_fedora/rdf/rdf_datastream.rb', line 78

def content_changed?
  return false unless instance_variable_defined? :@resource
  return true if empty_or_blank_subject? # can't be serialized because a subject hasn't been assigned yet.
  @content = serialize
  super
end

#deserialize(data = nil) ⇒ Object



145
146
147
148
149
150
151
152
153
154
# File 'lib/active_fedora/rdf/rdf_datastream.rb', line 145

def deserialize(data=nil)
  return ::RDF::Graph.new if new_record? && data.nil?
  data ||= remote_content

  # Because datastream_content can return nil, we should check that here.
  return ::RDF::Graph.new if data.nil?

  data.force_encoding('utf-8')
  ::RDF::Graph.new << ::RDF::Reader.for(serialization_format).new(data)
end

#empty_or_blank_subject?Boolean

Returns:

  • (Boolean)


85
86
87
# File 'lib/active_fedora/rdf/rdf_datastream.rb', line 85

def empty_or_blank_subject?
  resource.rdf_subject.node? || resource.rdf_subject.value.blank?
end

#freezeObject



89
90
91
# File 'lib/active_fedora/rdf/rdf_datastream.rb', line 89

def freeze
  @resource.freeze
end

#metadata?Boolean

Returns:

  • (Boolean)


59
60
61
# File 'lib/active_fedora/rdf/rdf_datastream.rb', line 59

def metadata?
  true
end

#parent_uriObject



55
56
57
# File 'lib/active_fedora/rdf/rdf_datastream.rb', line 55

def parent_uri
  self.class.parent_uri(self)
end

#refresh_attributesObject



119
120
121
# File 'lib/active_fedora/rdf/rdf_datastream.rb', line 119

def refresh_attributes
  @resource = nil
end

#resourceObject Also known as: graph

The resource is the RdfResource object that stores the graph for the datastream and is the central point for its relationship to other nodes.

set_value, get_value, and property accessors are delegated to this object.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# File 'lib/active_fedora/rdf/rdf_datastream.rb', line 99

def resource
  @resource ||= begin
                  klass = self.class.resource_class
                  klass.properties.merge(self.class.properties).each do |prop, config|
                    klass.property(config.term,
                                   predicate: config.predicate,
                                   class_name: config.class_name)
                  end
                  klass.accepts_nested_attributes_for(*nested_attributes_options.keys) unless nested_attributes_options.blank?
                  uri_stub = self.class.rdf_subject.call(self)

                  r = klass.new(uri_stub)
                  r.datastream = self
                  r << deserialize
                  r
                end
end

#serialization_formatObject



156
157
158
# File 'lib/active_fedora/rdf/rdf_datastream.rb', line 156

def serialization_format
  raise "you must override the `serialization_format' method in a subclass"
end

#serializeObject



140
141
142
143
# File 'lib/active_fedora/rdf/rdf_datastream.rb', line 140

def serialize
  resource.set_subject!(parent_uri) if parent_uri and rdf_subject.node?
  resource.dump serialization_format
end

#term_values(*values) ⇒ Object

This method allows for delegation. This patches the fact that there's no consistent API for allowing delegation - we're matching the OmDatastream implementation as our “consistency” point. @TODO: We may need to enable deep RDF delegation at one point.



128
129
130
# File 'lib/active_fedora/rdf/rdf_datastream.rb', line 128

def term_values(*values)
  self.send(values.first)
end

#update_indexed_attributes(hash) ⇒ Object



132
133
134
135
136
137
138
# File 'lib/active_fedora/rdf/rdf_datastream.rb', line 132

def update_indexed_attributes(hash)
  hash.each do |fields, value|
    fields.each do |field|
      self.send("#{field}=", value)
    end
  end
end

#uri=(uri) ⇒ Object



73
74
75
76
# File 'lib/active_fedora/rdf/rdf_datastream.rb', line 73

def uri=(uri)
  super
  resource.set_subject!(parent_uri) if empty_or_blank_subject?
end