CPub v0.3.0

RDF.FragmentGraph (CPub v0.3.0) View Source

A set of RDF triples about the same subject or fragments of the subject.

Blank nodes are not permitted.

An RDF.FragmentGraph defines a grouping of RDF triples about a certain subject that is suitable for content-addressing (see https://openengiadina.net/papers/content-addressable-rdf.html)

It is similar to a RDF.Description but additionally allows statements with fragments of the base subject as subject (e.g. If ~Ihttp://example.com/ is the base subject of the RDF.FragmentGraph then statements with subject ~Ihttp://example.com/#a-fragment are also permitted).

RDF.FragmentGraph implements:

Link to this section Summary

Types

coerce_options()
coercible_object()
coercible_predicate()
coercible_subject()
fragment_identifier()
fragment_statements()
object()
predicate()
statements()
subject()
t()

Functions

add(fg, statements)

Add statement to RDF.FragmentGraph.

add_fragment_statement(fg, fragment_identifier, arg)

Add object to a predicate of a fragemnt of the RDF.FragmentGraph.

coerce_iri(iri, list)
delete(fg, statements, opts \\ [])

Delete statement(s) from RDF.FragmentGraph.

delete_fragment_statement(fg, fragment_identifier, arg)

Delete a fragment statement from the RDF.FragmentGraph.

describes?(fg, iri)

Checks if the RDF.FragmentGraph contains a statement about given subject.

description(fg, subject)

Returns a RDF.Description of the given subject with statements in RDF.FragmentGraph.

descriptions(fg)
eris_finalizer(fg)
fetch(fg, subject)

Fetches the description of the given subject.

finalize(fg, finalizer \\ &eris_finalizer/1)

Finalize the RDF.FragmentGraph with a custom finalizer. The default finalizer sets the base subject to the ERIS URN of the content.

fragment_reference(id)

Returns a fragment reference to id.

get(fg, subject, default \\ nil)
graph(fg)

Return RDF.Graph for given RDF.FragmentGraph.

include?(fg, arg, opts)
map(fg, fun)
merge(fg, data, opts \\ [])
new()
new(data_or_iri)

Create a new RDF Fragment Graph.

objects(fg)

Returns a set of all objects in RDF.FragmentGraph

pop(fg)
pop(fg, key)

Pops the description of the given subject.

predicates(fg)

Retuns a set of all predicates in RDF.FragmentGraph

put(fg, input, opts \\ [])
put_properties(fg, input, opts \\ [])
resources(fg)
set_base_subject(fg, new_base_subject)

Set the base subject of RDF.FragmentGraph.

statement_count(fg)
statements(fg)

Returns a list of all statements in RDF.FragmentGraph.

subject_count(fg)
subjects(fg)

Returns a set of all subjects in RDF.FragmentGraph.

values(fg, opts \\ [])

Link to this section Types

Link to this type

coerce_options()

View Source

Specs

coerce_options() :: [{:base_subject, RDF.IRI.t()}]
Link to this type

coercible_object()

View Source

Specs

coercible_object() ::
  RDF.IRI.coercible()
  | RDF.Literal.t()
  | RDF.FragmentGraph.FragmentReference.t()
Link to this type

coercible_predicate()

View Source

Specs

coercible_predicate() ::
  RDF.IRI.coercible() | RDF.FragmentGraph.FragmentReference.t()
Link to this type

coercible_subject()

View Source

Specs

coercible_subject() :: RDF.IRI.coercible()
Link to this type

fragment_identifier()

View Source

Specs

fragment_identifier() :: String.t()
Link to this type

fragment_statements()

View Source

Specs

fragment_statements() :: %{optional(fragment_identifier()) => statements()}
Link to this type

object()

View Source

Specs

object() ::
  RDF.IRI.t() | RDF.Literal.t() | RDF.FragmentGraph.FragmentReference.t()
Link to this type

predicate()

View Source

Specs

predicate() :: RDF.IRI.t() | RDF.FragmentGraph.FragmentReference.t()
Link to this type

statements()

View Source

Specs

statements() :: %{optional(predicate()) => MapSet.t(object())}
Link to this type

subject()

View Source

Specs

subject() :: RDF.IRI.t()
Link to this type

t()

View Source

Specs

t() :: %RDF.FragmentGraph{
  base_subject: subject(),
  fragment_statements: fragment_statements(),
  statements: statements()
}

Link to this section Functions

Link to this function

add(fg, statements)

View Source

Specs

add(
  t(),
  {coercible_predicate(), coercible_object()}
  | RDF.Statement.t()
  | [RDF.Statement.t()]
  | RDF.Data.t()
) :: t()

Add statement to RDF.FragmentGraph.

Link to this function

add_fragment_statement(fg, fragment_identifier, arg)

View Source

Specs

add_fragment_statement(
  t(),
  fragment_identifier(),
  {coercible_predicate(), coercible_object()}
) :: t()

Add object to a predicate of a fragemnt of the RDF.FragmentGraph.

Link to this function

coerce_iri(iri, list)

View Source

Specs

coerce_iri(RDF.IRI.t(), coerce_options()) ::
  :base_subject | RDF.IRI.t() | RDF.FragmentGraph.FragmentReference.t()
Link to this function

delete(fg, statements, opts \\ [])

View Source

Specs

delete(
  t(),
  {coercible_predicate(), coercible_object()}
  | RDF.Statement.t()
  | [RDF.Statement.t()]
  | RDF.Data.t(),
  keyword()
) :: t()

Delete statement(s) from RDF.FragmentGraph.

Link to this function

delete_fragment_statement(fg, fragment_identifier, arg)

View Source

Specs

delete_fragment_statement(
  t(),
  fragment_identifier(),
  {coercible_predicate(), coercible_object()}
) :: t()

Delete a fragment statement from the RDF.FragmentGraph.

Link to this function

describes?(fg, iri)

View Source

Specs

describes?(t(), RDF.IRI.t()) :: bool()

Checks if the RDF.FragmentGraph contains a statement about given subject.

Link to this function

description(fg, subject)

View Source

Specs

description(t(), subject()) :: RDF.Description.t()

Returns a RDF.Description of the given subject with statements in RDF.FragmentGraph.

Link to this function

descriptions(fg)

View Source

Specs

descriptions(t()) :: [RDF.Description.t()]
Link to this function

eris_finalizer(fg)

View Source

Specs

eris_finalizer(t()) :: String.t()
Link to this function

fetch(fg, subject)

View Source

Specs

fetch(t(), RDF.Statement.coercible_subject()) ::
  {:ok, [RDF.Description.t()]} | :error

Fetches the description of the given subject.

When the subject can not be found :error is returned.

Link to this function

finalize(fg, finalizer \\ &eris_finalizer/1)

View Source

Specs

finalize(t(), (t() -> String.t())) :: t()

Finalize the RDF.FragmentGraph with a custom finalizer. The default finalizer sets the base subject to the ERIS URN of the content.

Link to this function

fragment_reference(id)

View Source

Returns a fragment reference to id.

This is a shortcut to RDF.FragmentGraph.FragmentReference.new(id).

Link to this function

get(fg, subject, default \\ nil)

View Source
Link to this function

graph(fg)

View Source

Specs

graph(t()) :: RDF.Graph.t()

Return RDF.Graph for given RDF.FragmentGraph.

Link to this function

include?(fg, arg, opts)

View Source

Specs

include?(t(), RDF.Statement.t(), keyword()) :: bool()
Link to this function

map(fg, fun)

View Source

Specs

map(t(), ({atom(), subject() | predicate() | object()} -> any())) :: map()
Link to this function

merge(fg, data, opts \\ [])

View Source

Specs

merge(t(), RDF.Statement.t(), keyword()) :: RDF.Graph.t()
Link to this function

new()

View Source

Specs

new() :: t()
Link to this function

new(data_or_iri)

View Source

Specs

new(RDF.IRI.coercible() | RDF.Data.t()) :: t()

Create a new RDF Fragment Graph.

Link to this function

objects(fg)

View Source

Specs

objects(t()) :: MapSet.t(object())

Returns a set of all objects in RDF.FragmentGraph

Link to this function

pop(fg)

View Source

Specs

pop(t()) :: {t() | nil, t()}
Link to this function

pop(fg, key)

View Source

Specs

pop(t(), RDF.Statement.coercible_subject()) :: {t() | nil, t()}

Pops the description of the given subject.

Link to this function

predicates(fg)

View Source

Specs

predicates(t()) :: MapSet.t(predicate())

Retuns a set of all predicates in RDF.FragmentGraph

Link to this function

put(fg, input, opts \\ [])

View Source

Specs

put(t(), t() | RDF.Graph.input(), keyword()) :: t()
Link to this function

put_properties(fg, input, opts \\ [])

View Source

Specs

put_properties(t(), t() | RDF.Graph.input(), keyword()) :: t()
Link to this function

resources(fg)

View Source

Specs

resources(t()) :: MapSet.t(subject() | predicate() | object())
Link to this function

set_base_subject(fg, new_base_subject)

View Source

Specs

set_base_subject(t(), RDF.IRI.coercible()) :: t()

Set the base subject of RDF.FragmentGraph.

Link to this function

statement_count(fg)

View Source

Specs

statement_count(t()) :: non_neg_integer()
Link to this function

statements(fg)

View Source

Specs

statements(t()) :: [RDF.Statement.t()]

Returns a list of all statements in RDF.FragmentGraph.

Link to this function

subject_count(fg)

View Source

Specs

subject_count(t()) :: non_neg_integer()
Link to this function

subjects(fg)

View Source

Specs

subjects(t()) :: MapSet.t(subject())

Returns a set of all subjects in RDF.FragmentGraph.

Link to this function

values(fg, opts \\ [])

View Source

Specs

values(
  t(),
  keyword()
) :: map()