JSON-LD.ex v0.2.0 JSON.LD View Source

Compaction is the process of applying a developer-supplied context to shorten IRIs to terms or compact IRIs and JSON-LD values expressed in expanded form to simple values such as strings or numbers. Often this makes it simpler to work with document as the data is expressed in application-specific terms. Compacted documents are also typically easier to read for humans.

— https://www.w3.org/TR/json-ld/#compacted-document-form

Details at https://www.w3.org/TR/json-ld-api/#compaction-algorithms

content_type()

The MIME type of the serialization format.

Callback implementation for RDF.Serialization.content_type/0.

context(args, opts \\ %JSON.LD.Options{})

Generator function for JSON.LD.Contexts.

You can either pass a map with a "@context" key having the JSON-LD context object its value, or the JSON-LD context object directly.

decoder()

The RDF.Serialization.Decoder module for the serialization format.

Callback implementation for RDF.Serialization.decoder/0.

encoder()

The RDF.Serialization.Encoder module for the serialization format.

Callback implementation for RDF.Serialization.encoder/0.

expand(input, options \\ %JSON.LD.Options{})

Expands the given input according to the steps in the JSON-LD Expansion Algorithm.

Expansion is the process of taking a JSON-LD document and applying a @context such that all IRIs, types, and values are expanded so that the @context is no longer necessary.

— https://www.w3.org/TR/json-ld/#expanded-document-form

Details at http://json-ld.org/spec/latest/json-ld-api/#expansion-algorithm

extension()

The usual file extension for the serialization format.

Callback implementation for RDF.Serialization.extension/0.

flatten(input, context \\ nil, options \\ %JSON.LD.Options{})

Flattens the given input according to the steps in the JSON-LD Flattening Algorithm.

Flattening collects all properties of a node in a single JSON object and labels all blank nodes with blank node identifiers. This ensures a shape of the data and consequently may drastically simplify the code required to process JSON-LD in certain applications.

— https://www.w3.org/TR/json-ld/#flattened-document-form

Details at https://www.w3.org/TR/json-ld-api/#flattening-algorithms

id()

An IRI of the serialization format.

Callback implementation for RDF.Serialization.id/0.

keyword?(value)

Returns if the given value is a JSON-LD keyword.

keywords()

The set of all JSON-LD keywords.

see https://www.w3.org/TR/json-ld/#syntax-tokens-and-keywords

node_map(input, node_id_map \\ nil)

Generator function for JSON-LD node maps.