# RDF.ex v3.0.0 - Table of Contents

An implementation of RDF for Elixir.

## Pages

- [About](readme.md)
- [CHANGELOG](changelog.md)
- [CONTRIBUTING](contributing.md)
- [License](license.md)

## Modules

- [RDF](RDF.md): The top-level module of RDF.ex.
- [RDF.Guards](RDF.Guards.md): A collection of guards.

- [RDF.Utils.Regex](RDF.Utils.Regex.md): Drop-in replacements for Elixir `Regex` functions.

- Terms
  - [RDF.BlankNode](RDF.BlankNode.md): An RDF blank node (aka bnode) is a local node of a graph without an IRI.
  - [RDF.IRI](RDF.IRI.md): A structure for IRIs.
  - [RDF.Literal](RDF.Literal.md): RDF literals are leaf nodes of an RDF graph containing raw data, like strings, numbers etc.
  - [RDF.Resource](RDF.Resource.md): Shared functions over `RDF.IRI`s and `RDF.BlankNode`s.

  - [RDF.Sigils](RDF.Sigils.md): Sigils for the most common types of RDF nodes.

  - [RDF.Term](RDF.Term.md): Shared behaviour for all RDF terms.

- Structures
  - [RDF.Dataset](RDF.Dataset.md): A set of `RDF.Graph`s.
  - [RDF.Description](RDF.Description.md): A set of RDF triples about the same subject.
  - [RDF.Diff](RDF.Diff.md): A data structure for diffs between `RDF.Graph`s and `RDF.Description`s.
  - [RDF.Graph](RDF.Graph.md): A set of RDF triples with an optional name.
  - [RDF.List](RDF.List.md): A structure for RDF lists.
  - [RDF.PrefixMap](RDF.PrefixMap.md): A mapping of prefix atoms to IRI namespaces.
  - [RDF.PropertyMap](RDF.PropertyMap.md): A bidirectional mapping from atom names to `RDF.IRI`s of properties.
  - [RDF.Quad](RDF.Quad.md): Helper functions for RDF quads.
  - [RDF.Statement](RDF.Statement.md): Helper functions for RDF statements.
  - [RDF.Triple](RDF.Triple.md): Helper functions for RDF triples.

- Protocols
  - [RDF.Data](RDF.Data.md): Functions for working with RDF data structures.
  - [RDF.Data.Source](RDF.Data.Source.md): Protocol for accessing and traversing RDF data structures.

- Namespace
  - [RDF.Namespace](RDF.Namespace.md): A behaviour and generator for modules of terms resolving to `RDF.IRI`s.
  - [RDF.Namespace.IRI](RDF.Namespace.IRI.md): Provides the `term_to_iri/1` macro to resolve IRI values inside of pattern matches.

  - [RDF.Vocabulary](RDF.Vocabulary.md): Various functions for working with RDF vocabularies and their URIs.

  - [RDF.Vocabulary.Namespace](RDF.Vocabulary.Namespace.md): An RDF vocabulary as a `RDF.Namespace`.

- Predefined namespaces
  - [RDF.NS](RDF.NS.md): `RDF.Namespace`s for fundamental RDF vocabularies.
  - [RDF.NS.OWL](RDF.NS.OWL.md): The OWL vocabulary.
  - [RDF.NS.RDF](RDF.NS.RDF.md): The RDF vocabulary.
  - [RDF.NS.RDFS](RDF.NS.RDFS.md): The RDFS vocabulary.
  - [RDF.NS.SKOS](RDF.NS.SKOS.md): The SKOS vocabulary.
  - [RDF.NS.XSD](RDF.NS.XSD.md): The XML Schema datatypes vocabulary.

- Predefined datatypes
  - [RDF.JSON](RDF.JSON.md): `RDF.Literal.Datatype` for `rdf:JSON`.
  - [RDF.LangString](RDF.LangString.md): `RDF.Literal.Datatype` for `rdf:langString`s.

  - [RDF.Literal.Generic](RDF.Literal.Generic.md): A generic `RDF.Literal.Datatype` for literals of an unknown datatype.

  - [RDF.XSD.AnyURI](RDF.XSD.AnyURI.md): `RDF.XSD.Datatype` for `xsd:anyURI`.
  - [RDF.XSD.Base64Binary](RDF.XSD.Base64Binary.md): `RDF.XSD.Datatype` for `xsd:base64Binary`.
  - [RDF.XSD.Boolean](RDF.XSD.Boolean.md): `RDF.XSD.Datatype` for `xsd:boolean`.
  - [RDF.XSD.Byte](RDF.XSD.Byte.md): `RDF.XSD.Datatype` for `xsd:byte`.
  - [RDF.XSD.Date](RDF.XSD.Date.md): `RDF.XSD.Datatype` for `xsd:date`.
  - [RDF.XSD.DateTime](RDF.XSD.DateTime.md): `RDF.XSD.Datatype` for `xsd:dateTime`.
  - [RDF.XSD.Decimal](RDF.XSD.Decimal.md): `RDF.XSD.Datatype` for `xsd:decimal`.
  - [RDF.XSD.Double](RDF.XSD.Double.md): `RDF.XSD.Datatype` for `xsd:double`.
  - [RDF.XSD.Float](RDF.XSD.Float.md): `RDF.XSD.Datatype` for `xsd:float`.
  - [RDF.XSD.Int](RDF.XSD.Int.md): `RDF.XSD.Datatype` for `xsd:int`.
  - [RDF.XSD.Integer](RDF.XSD.Integer.md): `RDF.XSD.Datatype` for `xsd:integer`.
  - [RDF.XSD.Long](RDF.XSD.Long.md): `RDF.XSD.Datatype` for `xsd:long`.
  - [RDF.XSD.NegativeInteger](RDF.XSD.NegativeInteger.md): `RDF.XSD.Datatype` for `xsd:negativeInteger`.
  - [RDF.XSD.NonNegativeInteger](RDF.XSD.NonNegativeInteger.md): `RDF.XSD.Datatype` for `xsd:nonNegativeInteger`.
  - [RDF.XSD.NonPositiveInteger](RDF.XSD.NonPositiveInteger.md): `RDF.XSD.Datatype` for `xsd:nonPositiveInteger`.
  - [RDF.XSD.Numeric](RDF.XSD.Numeric.md): Collection of functions for numeric literals.

  - [RDF.XSD.PositiveInteger](RDF.XSD.PositiveInteger.md): `RDF.XSD.Datatype` for `xsd:positiveInteger`.
  - [RDF.XSD.Short](RDF.XSD.Short.md): `RDF.XSD.Datatype` for `xsd:short`.
  - [RDF.XSD.String](RDF.XSD.String.md): `RDF.XSD.Datatype` for `xsd:string`.
  - [RDF.XSD.Time](RDF.XSD.Time.md): `RDF.XSD.Datatype` for `xsd:time`.
  - [RDF.XSD.UnsignedByte](RDF.XSD.UnsignedByte.md): `RDF.XSD.Datatype` for `xsd:unsignedByte`.
  - [RDF.XSD.UnsignedInt](RDF.XSD.UnsignedInt.md): `RDF.XSD.Datatype` for `xsd:unsignedInt`.
  - [RDF.XSD.UnsignedLong](RDF.XSD.UnsignedLong.md): `RDF.XSD.Datatype` for `xsd:unsignedLong`.
  - [RDF.XSD.UnsignedShort](RDF.XSD.UnsignedShort.md): `RDF.XSD.Datatype` for `xsd:unsignedShort`.

- Datatype system
  - [RDF.Literal.Datatype](RDF.Literal.Datatype.md): A behaviour for datatypes for `RDF.Literal`s.
  - [RDF.Literal.Datatype.Registry](RDF.Literal.Datatype.Registry.md): Registry of literal datatypes.

  - [RDF.XSD](RDF.XSD.md): An implementation of the XML Schema (XSD) datatype system for use within `RDF.Literal.Datatype` system.
  - [RDF.XSD.Datatype](RDF.XSD.Datatype.md): A behaviour for XSD datatypes.
  - [RDF.XSD.Datatype.Primitive](RDF.XSD.Datatype.Primitive.md): Macros for the definition of primitive XSD datatypes.

  - [RDF.XSD.Datatype.Restriction](RDF.XSD.Datatype.Restriction.md): A `__using__` macro for the derivation of restricted XSD datatypes.
  - [RDF.XSD.Facet](RDF.XSD.Facet.md): A behaviour for XSD restriction facets.
  - [RDF.XSD.Facets.ExplicitTimezone](RDF.XSD.Facets.ExplicitTimezone.md): `RDF.XSD.Facet` for `explicitTimezone`.
  - [RDF.XSD.Facets.FractionDigits](RDF.XSD.Facets.FractionDigits.md): `RDF.XSD.Facet` for `fractionDigits`.
  - [RDF.XSD.Facets.Length](RDF.XSD.Facets.Length.md): `RDF.XSD.Facet` for `length`.
  - [RDF.XSD.Facets.MaxExclusive](RDF.XSD.Facets.MaxExclusive.md): `RDF.XSD.Facet` for `maxExclusive`.
  - [RDF.XSD.Facets.MaxInclusive](RDF.XSD.Facets.MaxInclusive.md): `RDF.XSD.Facet` for `maxInclusive`.
  - [RDF.XSD.Facets.MaxLength](RDF.XSD.Facets.MaxLength.md): `RDF.XSD.Facet` for `maxLength`.
  - [RDF.XSD.Facets.MinExclusive](RDF.XSD.Facets.MinExclusive.md): `RDF.XSD.Facet` for `minExclusive`.
  - [RDF.XSD.Facets.MinInclusive](RDF.XSD.Facets.MinInclusive.md): `RDF.XSD.Facet` for `minInclusive`.
  - [RDF.XSD.Facets.MinLength](RDF.XSD.Facets.MinLength.md): `RDF.XSD.Facet` for `minLength`.
  - [RDF.XSD.Facets.Pattern](RDF.XSD.Facets.Pattern.md): `RDF.XSD.Facet` for `pattern`.
  - [RDF.XSD.Facets.TotalDigits](RDF.XSD.Facets.TotalDigits.md): `RDF.XSD.Facet` for `totalDigits`.

- Resource generators
  - [RDF.BlankNode.Generator](RDF.BlankNode.Generator.md): A GenServer which generates `RDF.BlankNode`s using a `RDF.BlankNode.Generator.Algorithm`.
  - [RDF.BlankNode.Generator.Algorithm](RDF.BlankNode.Generator.Algorithm.md): A behaviour for implementations of blank node identifier generation algorithms.
  - [RDF.BlankNode.Generator.Increment](RDF.BlankNode.Generator.Increment.md): An implementation of a `RDF.BlankNode.Generator.Algorithm` which returns `RDF.BlankNode`s with incremented identifiers.

  - [RDF.BlankNode.Generator.Random](RDF.BlankNode.Generator.Random.md): An implementation of a `RDF.BlankNode.Generator.Algorithm` which returns `RDF.BlankNode`s with random identifiers.
  - [RDF.BlankNode.Generator.UUID](RDF.BlankNode.Generator.UUID.md): An implementation of a `RDF.BlankNode.Generator.Algorithm` which returns `RDF.BlankNode`s with random UUID identifiers.

  - [RDF.IRI.UUID.Generator](RDF.IRI.UUID.Generator.md): A `RDF.Resource.Generator` for various kinds of UUID-based IRI identifiers.
  - [RDF.Resource.Generator](RDF.Resource.Generator.md): A configurable and customizable way to generate resource identifiers.

- Serialization
  - [RDF.NQuads](RDF.NQuads.md): `RDF.NQuads` provides support for the N-Quads serialization format.
  - [RDF.NQuads.Decoder](RDF.NQuads.Decoder.md): A decoder for N-Quads serializations to `RDF.Dataset`s.
  - [RDF.NQuads.Encoder](RDF.NQuads.Encoder.md): An encoder for N-Quads serializations of RDF.ex data structures.
  - [RDF.NTriples](RDF.NTriples.md): `RDF.NTriples` provides support for the N-Triples serialization format.
  - [RDF.NTriples.Decoder](RDF.NTriples.Decoder.md): A decoder for N-Triples serializations to `RDF.Graph`s.
  - [RDF.NTriples.Encoder](RDF.NTriples.Encoder.md): An encoder for N-Triples serializations of RDF.ex data structures.
  - [RDF.Serialization](RDF.Serialization.md): Functions for working with RDF serializations generically.
  - [RDF.Serialization.Decoder](RDF.Serialization.Decoder.md): A behaviour for decoders of strings encoded in a specific `RDF.Serialization` format.

  - [RDF.Serialization.Encoder](RDF.Serialization.Encoder.md): A behaviour for encoders of RDF data structures in a specific `RDF.Serialization` format.

  - [RDF.Serialization.Format](RDF.Serialization.Format.md): A behaviour for RDF serialization formats.
  - [RDF.TriG](RDF.TriG.md): `RDF.TriG` provides support for the TriG serialization format.
  - [RDF.TriG.Decoder](RDF.TriG.Decoder.md): A decoder for TriG serializations to `RDF.Dataset`s.
  - [RDF.TriG.Encoder](RDF.TriG.Encoder.md): An encoder for TriG serializations of RDF.ex data structures.
  - [RDF.Turtle](RDF.Turtle.md): `RDF.Turtle` provides support for the Turtle serialization format.
  - [RDF.Turtle.Decoder](RDF.Turtle.Decoder.md): A decoder for Turtle serializations to `RDF.Graph`s.
  - [RDF.Turtle.Encoder](RDF.Turtle.Encoder.md): An encoder for Turtle serializations of RDF.ex data structures.

- Query engine
  - [RDF.Query](RDF.Query.md): The RDF Graph query API.

  - [RDF.Query.BGP](RDF.Query.BGP.md): A struct for Basic Graph Pattern queries.

- Canonicalization
  - [RDF.Canonicalization](RDF.Canonicalization.md): An implementation of the standard RDF Dataset Canonicalization Algorithm.
  - [RDF.Canonicalization.IdentifierIssuer](RDF.Canonicalization.IdentifierIssuer.md): An identifier issuer is used to issue new blank node identifier.
  - [RDF.Canonicalization.State](RDF.Canonicalization.State.md): State of the `RDF.Canonicalization` algorithm.

- RDF-star
  - [RDF.Star.Quad](RDF.Star.Quad.md): Helper functions for RDF-star quads.
  - [RDF.Star.Statement](RDF.Star.Statement.md): Helper functions for RDF-star statements.
  - [RDF.Star.Triple](RDF.Star.Triple.md): Helper functions for RDF-star triples.

- Test
  - [RDF.Test.Assertions](RDF.Test.Assertions.md): Assertions for ExUnit tests.

  - [RDF.Test.EarlFormatter](RDF.Test.EarlFormatter.md): An `ExUnit.Formatter` implementation that generates EARL reports.

- Exceptions
  - [RDF.Graph.Builder.Error](RDF.Graph.Builder.Error.md)
  - [RDF.Graph.EmptyDescriptionError](RDF.Graph.EmptyDescriptionError.md)
  - [RDF.IRI.InvalidError](RDF.IRI.InvalidError.md)
  - [RDF.Literal.InvalidError](RDF.Literal.InvalidError.md)
  - [RDF.Namespace.InvalidTermError](RDF.Namespace.InvalidTermError.md)
  - [RDF.Namespace.UndefinedTermError](RDF.Namespace.UndefinedTermError.md)
  - [RDF.Quad.InvalidGraphContextError](RDF.Quad.InvalidGraphContextError.md)
  - [RDF.Query.InvalidError](RDF.Query.InvalidError.md)
  - [RDF.Resource.Generator.ConfigError](RDF.Resource.Generator.ConfigError.md)
  - [RDF.Triple.InvalidPredicateError](RDF.Triple.InvalidPredicateError.md)
  - [RDF.Triple.InvalidSubjectError](RDF.Triple.InvalidSubjectError.md)
  - [RDF.Vocabulary.Namespace.CaseValidation.CaseViolationError](RDF.Vocabulary.Namespace.CaseValidation.CaseViolationError.md)
  - [RDF.Vocabulary.Namespace.CompileError](RDF.Vocabulary.Namespace.CompileError.md)
  - [RDF.Vocabulary.Namespace.TermMapping.InvalidAliasError](RDF.Vocabulary.Namespace.TermMapping.InvalidAliasError.md)
  - [RDF.Vocabulary.Namespace.TermMapping.InvalidIgnoreTermError](RDF.Vocabulary.Namespace.TermMapping.InvalidIgnoreTermError.md)
  - [RDF.Vocabulary.Namespace.TermMapping.InvalidTermError](RDF.Vocabulary.Namespace.TermMapping.InvalidTermError.md)
  - [RDF.Vocabulary.Namespace.TermMapping.InvalidVocabBaseIRIError](RDF.Vocabulary.Namespace.TermMapping.InvalidVocabBaseIRIError.md)
  - [RDF.Vocabulary.Namespace.TermMapping.TermHandlerError](RDF.Vocabulary.Namespace.TermMapping.TermHandlerError.md)
  - [RDF.Vocabulary.Namespace.TermMapping.UnknownTermError](RDF.Vocabulary.Namespace.TermMapping.UnknownTermError.md)
  - [RDF.XSD.Datatype.MismatchError](RDF.XSD.Datatype.MismatchError.md)