RDF (RDF.ex v0.9.2) View Source

The top-level module of RDF.ex.

RDF.ex consists of:

modules for the nodes of an RDF graph
the RDF.Literal.Datatype system
a facility for the mapping of URIs of a vocabulary to Elixir modules and functions: RDF.Vocabulary.Namespace
modules for the construction of statements
modules for collections of statements
functions to construct and execute basic graph pattern queries: RDF.Query
functions for working with RDF serializations: RDF.Serialization
behaviours for the definition of RDF serialization formats
and the implementation of various RDF serialization formats

This top-level module provides shortcut functions for the construction of the basic elements and structures of RDF and some general helper functions.

For a general introduction you may refer to the guides on the homepage.

Link to this section Summary

Functions

bnode()

See RDF.BlankNode.new/0.

bnode(id)

See RDF.BlankNode.new/1.

bnode?(arg1)

Checks if the given value is a blank node.

dataset()

See RDF.Dataset.new/0.

dataset(arg)

See RDF.Dataset.new/1.

dataset(arg1, arg2)

See RDF.Dataset.new/2.

default_base_iri()

See RDF.IRI.default_base/0.

default_prefixes()

A user-defined RDF.PrefixMap of prefixes to IRI namespaces.

default_prefixes(prefix_mappings)

Returns the default_prefixes/0 with additional prefix mappings.

description(subject, opts \\ [])

See RDF.Description.new/2.

diff(arg1, arg2)

See RDF.Diff.diff/2.

first()

See RDF.NS.RDF.first/0.

graph()

See RDF.Graph.new/0.

graph(arg)

See RDF.Graph.new/1.

graph(arg1, arg2)

See RDF.Graph.new/2.

iri(value)

See RDF.IRI.new/1.

iri!(value)

See RDF.IRI.new!/1.

iri?(value)

See RDF.IRI.valid?/1.

langString()

See RDF.NS.RDF.langString/0.

langString(value, opts)

See RDF.LangString.new/2.

lang_string()

See RDF.NS.RDF.langString/0.

lang_string(value, opts)

See RDF.LangString.new/2.

list(native_list)

list(head, graph)

list?(description)

See RDF.List.node?/1.

list?(resource, graph)

See RDF.List.node?/2.

literal(value)

See RDF.Literal.new/1.

literal(value, opts)

See RDF.Literal.new/2.

literal?(arg1)

Checks if the given value is a RDF literal.

nil()

See RDF.NS.RDF.nil/0.

object()

See RDF.NS.RDF.object/0.

predicate()

See RDF.NS.RDF.predicate/0.

prefix_map(prefixes)

See RDF.PrefixMap.new/1.

property_map(property_map)

See RDF.PropertyMap.new/1.

quad(tuple)

See RDF.Quad.new/1.

quad(s, p, o, g)

See RDF.Quad.new/4.

read_file(filename, opts \\ [])

See RDF.Serialization.read_file/2.

read_file!(filename, opts \\ [])

See RDF.Serialization.read_file!/2.

read_stream(stream, opts \\ [])

See RDF.Serialization.read_stream/2.

read_stream!(stream, opts \\ [])

See RDF.Serialization.read_stream!/2.

read_string(string, opts)

See RDF.Serialization.read_string/2.

read_string!(string, opts)

See RDF.Serialization.read_string!/2.

resource?(value)

Checks if the given value is a RDF resource.

rest()

See RDF.NS.RDF.rest/0.

standard_prefixes()

A fixed set prefixes that will always be part of the default_prefixes/0.

subject()

See RDF.NS.RDF.subject/0.

term?(value)

Checks if the given value is a RDF term.

triple(tuple)

See RDF.Triple.new/1.

triple(s, p, o)

See RDF.Triple.new/3.

type()

See RDF.NS.RDF.type/0.

uri(value)

See RDF.IRI.new/1.

uri!(value)

See RDF.IRI.new!/1.

uri?(value)

See RDF.IRI.valid?/1.

value()

See RDF.NS.RDF.value/0.

write_file(data, filename, opts \\ [])

See RDF.Serialization.write_file/3.

write_file!(data, filename, opts \\ [])

See RDF.Serialization.write_file!/3.

write_stream(data, opts)

See RDF.Serialization.write_stream/2.

write_string(data, opts)

See RDF.Serialization.write_string/2.

write_string!(data, opts)

See RDF.Serialization.write_string!/2.

Link to this section Functions

bnode()

See RDF.BlankNode.new/0.

bnode(id)

See RDF.BlankNode.new/1.

bnode?(arg1)

Checks if the given value is a blank node.

Examples

iex> RDF.bnode?(RDF.bnode)
true
iex> RDF.bnode?(RDF.iri("http://example.com/resource"))
false
iex> RDF.bnode?(42)
false

dataset()

See RDF.Dataset.new/0.

dataset(arg)

See RDF.Dataset.new/1.

dataset(arg1, arg2)

See RDF.Dataset.new/2.

default_base_iri()

See RDF.IRI.default_base/0.

default_prefixes()

A user-defined RDF.PrefixMap of prefixes to IRI namespaces.

This prefix map will be used implicitly wherever a prefix map is expected, but not provided. For example, when you don't pass a prefix map to the Turtle serializer, this prefix map will be used.

By default the standard_prefixes/0 are part of this prefix map, but you can define additional default prefixes via the default_prefixes compile-time configuration.

For example:

config :rdf,
  default_prefixes: %{
    ex: "http://example.com/"
  }

If you don't want the standard_prefixes/0 to be part of the default prefixes, or you want to map the standard prefixes to different namespaces (strongly discouraged!), you can set the use_standard_prefixes compile-time configuration flag to false.

config :rdf,
  use_standard_prefixes: false

default_prefixes(prefix_mappings)

Returns the default_prefixes/0 with additional prefix mappings.

The prefix_mappings can be given in any format accepted by RDF.PrefixMap.new/1.

description(subject, opts \\ [])

See RDF.Description.new/2.

diff(arg1, arg2)

See RDF.Diff.diff/2.

first()

See RDF.NS.RDF.first/0.

graph()

See RDF.Graph.new/0.

graph(arg)

See RDF.Graph.new/1.

graph(arg1, arg2)

See RDF.Graph.new/2.

iri(value)

See RDF.IRI.new/1.

iri!(value)

See RDF.IRI.new!/1.

iri?(value)

See RDF.IRI.valid?/1.

langString()

See RDF.NS.RDF.langString/0.

langString(value, opts)

See RDF.LangString.new/2.

lang_string()

See RDF.NS.RDF.langString/0.

lang_string(value, opts)

See RDF.LangString.new/2.

list(native_list)

list(head, graph)

list?(description)

See RDF.List.node?/1.

list?(resource, graph)

See RDF.List.node?/2.

literal(value)

See RDF.Literal.new/1.

literal(value, opts)

See RDF.Literal.new/2.

literal?(arg1)

Checks if the given value is a RDF literal.

nil()

See RDF.NS.RDF.nil/0.

object()

See RDF.NS.RDF.object/0.

predicate()

See RDF.NS.RDF.predicate/0.

prefix_map(prefixes)

See RDF.PrefixMap.new/1.

property_map(property_map)

See RDF.PropertyMap.new/1.

quad(tuple)

See RDF.Quad.new/1.

quad(s, p, o, g)

See RDF.Quad.new/4.

read_file(filename, opts \\ [])

See RDF.Serialization.read_file/2.

read_file!(filename, opts \\ [])

See RDF.Serialization.read_file!/2.

read_stream(stream, opts \\ [])

See RDF.Serialization.read_stream/2.

read_stream!(stream, opts \\ [])

See RDF.Serialization.read_stream!/2.

read_string(string, opts)

See RDF.Serialization.read_string/2.

read_string!(string, opts)

See RDF.Serialization.read_string!/2.

resource?(value)

Checks if the given value is a RDF resource.

Examples

Supposed EX is a RDF.Vocabulary.Namespace and Foo is not.

iex> RDF.resource?(RDF.iri("http://example.com/resource"))
true
iex> RDF.resource?(EX.resource)
true
iex> RDF.resource?(EX.Resource)
true
iex> RDF.resource?(Foo.Resource)
false
iex> RDF.resource?(RDF.bnode)
true
iex> RDF.resource?(RDF.XSD.integer(42))
false
iex> RDF.resource?(42)
false

rest()

See RDF.NS.RDF.rest/0.

standard_prefixes()

A fixed set prefixes that will always be part of the default_prefixes/0.

%RDF.PrefixMap{
  rdf: ~I<http://www.w3.org/1999/02/22-rdf-syntax-ns#>,
  rdfs: ~I<http://www.w3.org/2000/01/rdf-schema#>,
  xsd: ~I<http://www.w3.org/2001/XMLSchema#>
}

See default_prefixes/0, if you don't want these standard prefixes to be part of the default prefixes.

subject()

See RDF.NS.RDF.subject/0.

term?(value)

Checks if the given value is a RDF term.

Examples

Supposed EX is a RDF.Vocabulary.Namespace and Foo is not.

iex> RDF.term?(RDF.iri("http://example.com/resource"))
true
iex> RDF.term?(EX.resource)
true
iex> RDF.term?(EX.Resource)
true
iex> RDF.term?(Foo.Resource)
false
iex> RDF.term?(RDF.bnode)
true
iex> RDF.term?(RDF.XSD.integer(42))
true
iex> RDF.term?(42)
false