jelly-core
API
Generated with
jelly-core/eu.ostrzyciel.jelly.core

eu.ostrzyciel.jelly.core

package eu.ostrzyciel.jelly.core

Members list

Packages

package eu.ostrzyciel.jelly.core.proto.v1

Type members

Classlikes

object Constants

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Constants.type
object ConverterFactory

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait ConverterFactory[+TEncoder <: ProtoEncoder[TNode, TTriple, TQuad, _], +TDecConv <: ProtoDecoderConverter[TNode, TDatatype, TTriple, TQuad], TNode, TDatatype, TTriple, TQuad](implicit evidence$1: ClassTag[TDatatype])

"Main" trait to be implemented by RDF conversion modules (e.g., for Jena and RDF4J). Exposes factory methods for building protobuf encoders and decoders.

"Main" trait to be implemented by RDF conversion modules (e.g., for Jena and RDF4J). Exposes factory methods for building protobuf encoders and decoders.

This should typically be implemented as an object. You should also provide a package-scoped given for your implementation so that users can easily make use of the connector in the stream package.

Type parameters

TDatatype

Type of RDF datatypes in the RDF library

TDecConv

Implementation of ProtoDecoderConverter for a given RDF library.

TEncoder

Implementation of ProtoEncoder for a given RDF library.

TNode

Type of RDF nodes in the RDF library

TQuad

Type of quad statements in the RDF library.

TTriple

Type of triple statements in the RDF library.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object IterableAdapter

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait IterableAdapter[+TNode, +TTriple, +TQuad, -TGraph, -TDataset]

Generic trait for making converters from graph- and dataset-like structures to scala.collection.immutable.Iterable of triples and quads.

Generic trait for making converters from graph- and dataset-like structures to scala.collection.immutable.Iterable of triples and quads.

These converters can be used to feed the streaming encoders in the stream module.

Warning: the converters assume that the underlying structures are static! If they change during iteration, the results are undefined.

Type parameters

TDataset

dataset type

TGraph

graph type

TNode

node type

TQuad

quad type

TTriple

triple type

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object JellyOptions

A collection of convenient streaming option presets. None of the presets specifies the stream type – do that with the .withPhysicalType method.

A collection of convenient streaming option presets. None of the presets specifies the stream type – do that with the .withPhysicalType method.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object LogicalStreamTypeFactory

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
trait ProtoDecoder[+TOut]

Base extendable trait for decoders of protobuf RDF streams.

Base extendable trait for decoders of protobuf RDF streams.

See the implementation in ProtoDecoderImpl.

Type parameters

TOut

Type of the output of the decoder.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ProtoDecoderImpl[TNode, TDatatype, TTriple, TQuad, TOut]
trait ProtoDecoderConverter[TNode, TDatatype, +TTriple, +TQuad]

Converter trait for translating between Jelly's object representation of RDF and that of RDF libraries.

Converter trait for translating between Jelly's object representation of RDF and that of RDF libraries.

You need to implement this trait to adapt Jelly to a new RDF library.

Type parameters

TDatatype

type of RDF datatypes in the library

TNode

type of RDF nodes in the library

TQuad

type of quad statements in the library

TTriple

type of triple statements (not quoted triples) in the library

Attributes

Supertypes
class Object
trait Matchable
class Any
sealed abstract class ProtoDecoderImpl[TNode, TDatatype, +TTriple, +TQuad, +TOut](converter: ProtoDecoderConverter[TNode, TDatatype, TTriple, TQuad], supportedOptions: RdfStreamOptions)(implicit evidence$1: ClassTag[TDatatype]) extends ProtoDecoder[TOut]

Base class for stateful decoders of protobuf RDF streams.

Base class for stateful decoders of protobuf RDF streams.

See the base (extendable) trait: ProtoDecoder.

Attributes

Companion
object
Supertypes
trait ProtoDecoder[TOut]
class Object
trait Matchable
class Any
object ProtoDecoderImpl

Implementations of the ProtoDecoder trait.

Implementations of the ProtoDecoder trait.

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
object ProtoEncoder

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
abstract class ProtoEncoder[TNode, -TTriple, -TQuad, -TQuoted](val options: RdfStreamOptions)

Stateful encoder of a protobuf RDF stream.

Stateful encoder of a protobuf RDF stream.

This class supports all stream types and options, but usually does not check if the user is conforming to them. It will, for example, allow the user to send generalized triples in a stream that should not have them. Take care to ensure the correctness of the transmitted data, or use the specialized wrappers from the stream package.

Value parameters

options

options for this stream

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any

Exports

Defined exports

final type RdfProtoDeserializationError = RdfProtoDeserializationError
Exported from JellyExceptions
final type RdfProtoSerializationError = RdfProtoSerializationError
Exported from JellyExceptions
val staxPrefix: String
Exported from LogicalStreamTypeExtensions
Generated with