Class: RDF::Graph

Inherits:
Object
  • Object
show all
Includes:
Countable, Durable, Enumerable, Mutable, Queryable, Value
Defined in:
lib/rdf/model/graph.rb

Overview

An RDF graph.

An Graph contains a unique set of Statement. It is based on an underlying data object, which may be specified when the graph is initialized, and will default to a Repository without support for named graphs otherwise.

Note that in RDF 1.1, graphs are not named, but are associated with a graph name in a Dataset, as a pair of . This class allows a name to be associated with a graph when it is a projection of an underlying Repository supporting graph_names.

Examples:

Creating an empty unnamed graph

graph = RDF::Graph.new

Loading graph data from a URL

graph = RDF::Graph.load("http://ruby-rdf.github.io/rdf/etc/doap.nt")

Loading graph data from a URL

require 'rdf/rdfxml'  # for RDF/XML support

graph = RDF::Graph.load("http://www.bbc.co.uk/programmes/b0081dq5.rdf")

Accessing a specific named graph within a Repository

require 'rdf/trig'  # for TriG support

repository = graph = RDF::Repository.load("https://raw.githubusercontent.com/ruby-rdf/rdf-trig/develop/etc/doap.trig", format: :trig))
graph = RDF::Graph.new(RDF::URI("http://greggkellogg.net/foaf#me"), data: repository)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Mutable

#<<, #clear, #delete, #delete_statements, #immutable?, #insert, #load, #method_missing, #mutable?, #update

Methods included from Util::Aliasing::LateBound

#alias_method

Methods included from Writable

#<<, #insert, #insert_graph, #insert_reader, #insert_statements, #writable?

Methods included from Readable

#readable?

Methods included from Queryable

#first, #first_literal, #first_object, #first_predicate, #first_subject, #first_value, #query, #query_execute

Methods included from Enumerable

#dump, #each_context, #each_object, #each_predicate, #each_quad, #each_statement, #each_subject, #each_triple, #enum_context, #enum_graph, #enum_object, #enum_predicate, #enum_quad, #enum_statement, #enum_subject, #enum_triple, #has_context?, #has_graph?, #has_object?, #has_predicate?, #has_quad?, #has_subject?, #has_triple?, #invalid?, #method_missing, #objects, #predicates, #quads, #statements, #subjects, #supports?, #to_a, #to_hash, #to_set, #triples, #valid?, #validate!

Methods included from Countable

#empty?

Methods included from Durable

#nondurable?

Methods included from Value

#canonicalize, #canonicalize!, #constant?, #inspect, #inspect!, #invalid?, #iri?, #list?, #literal?, #node?, #resource?, #statement?, #term?, #to_nquads, #to_ntriples, #to_rdf, #to_term, #type_error, #uri?, #valid?, #validate!, #variable?

Constructor Details

#initialize(graph_name, options) ⇒ Graph #initialize(options) ⇒ Graph

Returns a new instance of Graph

Overloads:

  • #initialize(graph_name, options) ⇒ Graph
    Note:

    Contexts are only useful when used as a projection on a :data which supports named graphs. Otherwise, there is no such thing as a named graph in RDF 1.1, a repository may have graphs which are named, but the name is not a property of the graph.

    Options Hash (options):

    • :data (RDF::Queryable) — default: RDF::Repository.new

      Storage behind this graph.

    Raises:

    • (ArgumentError)

      if a data does not support named graphs.

  • #initialize(options) ⇒ Graph

    Options Hash (options):

    • :data (RDF::Queryable) — default: RDF::Repository.new

      Storage behind this graph.

Yields:

  • (graph)

Yield Parameters:

Raises:

  • (ArgumentError)


118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# File 'lib/rdf/model/graph.rb', line 118

def initialize(*args, &block)
  graph_name = args.shift unless args.first.is_a?(Hash)
  options = args.first || {}
  @graph_name = case graph_name
    when nil then nil
    when RDF::Resource then graph_name
    else RDF::URI.new(graph_name)
  end

  @options = options.dup
  @data    = @options.delete(:data) || RDF::Repository.new(with_graph_name: false)

  raise ArgumentError, "Can't apply graph_name unless initialized with `data` supporting graph_names" if
    @graph_name && !@data.supports?(:graph_name)

  if block_given?
    case block.arity
      when 1 then block.call(self)
      else instance_eval(&block)
    end
  end
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class RDF::Mutable

Instance Attribute Details

#dataRDF::Queryable

Queryable backing this graph.



70
71
72
# File 'lib/rdf/model/graph.rb', line 70

def data
  @data
end

#graph_nameRDF::Resource Also known as: name

Deprecated.

Use #graph_name instead.

Name of this graph, if it is part of an Repository

Since:

  • 1.1.0



51
52
53
# File 'lib/rdf/model/graph.rb', line 51

def graph_name
  @graph_name
end

#optionsHash{Symbol => Object} (readonly)

Returns the options passed to this graph when it was constructed.



44
45
46
# File 'lib/rdf/model/graph.rb', line 44

def options
  @options
end

Class Method Details

.load(url, options = {}) {|graph| ... } ⇒ Graph

Creates a new Graph instance populated by the RDF data returned by dereferencing the given graph_name Resource.

Yields:

  • (graph)

Yield Parameters:

Since:

  • 0.1.7



83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/rdf/model/graph.rb', line 83

def self.load(url, options = {}, &block)
  self.new(options) do |graph|
    graph.load(url, options)

    if block_given?
      case block.arity
        when 1 then block.call(graph)
        else graph.instance_eval(&block)
      end
    end
  end
end

Instance Method Details

#==(other) ⇒ Boolean

Graph equivalence based on the contents of each graph being exactly the same. To determine if the have the same meaning, consider rdf-isomorphic.



278
279
280
281
282
# File 'lib/rdf/model/graph.rb', line 278

def ==(other)
  other.is_a?(RDF::Graph) &&
  graph_name == other.graph_name &&
  statements.to_a == other.statements.to_a
end

#anonymous?Boolean

Note:

The next release, graphs will not be named, this will return true

Returns true if this graph has an anonymous graph, false otherwise.



228
229
230
# File 'lib/rdf/model/graph.rb', line 228

def anonymous?
  graph_name.nil? ? false : graph_name.anonymous?
end

#contextRDF::Resource

Deprecated.

Use #graph_name instead.

Name of this graph, if it is part of an Repository

Since:

  • 1.1.0



61
62
63
64
# File 'lib/rdf/model/graph.rb', line 61

def context
  warn "[DEPRECATION] Graph#context is being replaced with Graph@graph_name in RDF.rb 2.0. Called from #{Gem.location_of_caller.join(':')}"
 graph_name
end

#contexts(options = {}) ⇒ Enumerator<RDF::Resource>

Deprecated.

Use #graph_names instead.

Returns all unique RDF contexts for this graph.



194
195
196
197
# File 'lib/rdf/model/graph.rb', line 194

def contexts(options = {})
  warn "[DEPRECATION] Graph#contexts is being replaced with Graph#graph_names in RDF.rb 2.0. Called from #{Gem.location_of_caller.join(':')}"
  (named? ? [context] : []).to_enum.extend(RDF::Countable)
end

#countInteger

Returns the number of RDF statements in this graph.

See Also:

  • Enumerable#count


237
238
239
# File 'lib/rdf/model/graph.rb', line 237

def count
  @data.query(graph_name: graph_name || false).count
end

#durable?Boolean

A graph is durable if it's underlying data model is durable

See Also:



185
186
187
# File 'lib/rdf/model/graph.rb', line 185

def durable?
  @data.durable?
end

#each {|statement| ... } ⇒ Enumerator

Enumerates each RDF statement in this graph.

Yields:

  • (statement)

Yield Parameters:

See Also:



260
261
262
263
264
265
266
267
268
# File 'lib/rdf/model/graph.rb', line 260

def each(&block)
  if @data.respond_to?(:query)
    @data.query(graph_name: graph_name || false, &block)
  elsif @data.respond_to?(:each)
    @data.each(&block)
  else
    @data.to_a.each(&block)
  end
end

#graph?Boolean

Returns true to indicate that this is a graph.



158
159
160
# File 'lib/rdf/model/graph.rb', line 158

def graph?
  true
end

#graph_names(options = {}) ⇒ Enumerator<RDF::Resource>

Returns all unique RDF names for this graph.



203
204
205
# File 'lib/rdf/model/graph.rb', line 203

def graph_names(options = {})
  (named? ? [graph_name] : []).extend(RDF::Countable)
end

#has_statement?(statement) ⇒ Boolean

Returns true if this graph contains the given RDF statement.



247
248
249
250
251
# File 'lib/rdf/model/graph.rb', line 247

def has_statement?(statement)
  statement = statement.dup
  statement.graph_name = graph_name
  @data.has_statement?(statement)
end

#load!(*args)

This method returns an undefined value.

(re)loads the graph from the specified location, or from the location associated with the graph name, if any

See Also:



145
146
147
148
149
150
151
152
# File 'lib/rdf/model/graph.rb', line 145

def load!(*args)
  case
    when args.empty?
      raise ArgumentError, "Can't reload graph without a graph_name" unless graph_name.is_a?(RDF::URI)
      load(graph_name.to_s, {base_uri: graph_name}.merge(@options))
    else super
  end
end

#named?Boolean

Note:

The next release, graphs will not be named, this will return false

Returns true if this is a named graph.



167
168
169
# File 'lib/rdf/model/graph.rb', line 167

def named?
  !unnamed?
end

#to_sString

Returns a string representation of this graph.



219
220
221
# File 'lib/rdf/model/graph.rb', line 219

def to_s
  named? ? graph_name.to_s : "default"
end

#to_uriRDF::Resource

Returns the Resource representation of this graph.



211
212
213
# File 'lib/rdf/model/graph.rb', line 211

def to_uri
  graph_name
end

#unnamed?Boolean

Note:

The next release, graphs will not be named, this will return true

Returns true if this is a unnamed graph.



176
177
178
# File 'lib/rdf/model/graph.rb', line 176

def unnamed?
  graph_name.nil?
end