jelly-stream
API
Generated with
jelly-stream/eu.ostrzyciel.jelly.stream/EncoderFlow

EncoderFlow

eu.ostrzyciel.jelly.stream.EncoderFlow
object EncoderFlow

Factory of encoder flows for Jelly streams. When using these methods, you don't have to set the physicalType and logicalType properties of RdfStreamOptions. They will be set automatically. You can set the logical stream type manually, though.

These methods will also ensure that the produced stream is more-or-less valid (that it adheres to the appropriate physical and logical stream type).

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

final def datasetStream[TNode, TTriple](maybeLimiter: Option[SizeLimiter], opt: RdfStreamOptions)(using factory: ConverterFactory[_, _, TNode, _, TTriple, _]): Flow[IterableOnce[(TNode, Iterable[TTriple])], RdfStreamFrame, NotUsed]

A flow converting a stream of datasets (iterables with named or unnamed graphs: node as graph name + iterable of triple statements) into a stream of RdfStreamFrames. Each element in the output stream may contain multiple graphs, a single graph, or a part of a graph (if the frame size limiter is used). Physical stream type: GRAPHS. Logical stream type (RDF-STaX): RDF dataset stream (DATASETS).

A flow converting a stream of datasets (iterables with named or unnamed graphs: node as graph name + iterable of triple statements) into a stream of RdfStreamFrames. Each element in the output stream may contain multiple graphs, a single graph, or a part of a graph (if the frame size limiter is used). Physical stream type: GRAPHS. Logical stream type (RDF-STaX): RDF dataset stream (DATASETS).

Each dataset in the input stream is guaranteed to correspond to exactly one RdfStreamFrame in the output stream IF no frame size limiter is applied.

Type parameters

TNode

Type of nodes.

TTriple

Type of triple statements.

Value parameters

factory

Implementation of ConverterFactory (e.g., JenaConverterFactory).

maybeLimiter

frame size limiter (see SizeLimiter). If None, no size limit is applied (frames are only split by groups).

opt

Jelly serialization options.

Attributes

Returns

Pekko Streams flow.

final def datasetStreamFromQuads[TQuad](maybeLimiter: Option[SizeLimiter], opt: RdfStreamOptions)(using factory: ConverterFactory[_, _, _, _, _, TQuad]): Flow[IterableOnce[TQuad], RdfStreamFrame, NotUsed]

A flow converting a stream of datasets (iterables with quad statements) into a stream of RdfStreamFrames. Physical stream type: QUADS. Logical stream type (RDF-STaX): RDF dataset stream (DATASETS).

A flow converting a stream of datasets (iterables with quad statements) into a stream of RdfStreamFrames. Physical stream type: QUADS. Logical stream type (RDF-STaX): RDF dataset stream (DATASETS).

Each dataset (iterable of quads) in the input stream is guaranteed to correspond to exactly one RdfStreamFrame in the output stream IF no frame size limiter is applied.

Type parameters

TQuad

Type of quad statements.

Value parameters

factory

Implementation of ConverterFactory (e.g., JenaConverterFactory).

maybeLimiter

frame size limiter (see SizeLimiter). If None, no size limit is applied (frames are only split by datasets).

opt

Jelly serialization options.

Attributes

Returns

Pekko Streams flow.

final def flatQuadStream[TQuad](limiter: SizeLimiter, opt: RdfStreamOptions)(using factory: ConverterFactory[_, _, _, _, _, TQuad]): Flow[TQuad, RdfStreamFrame, NotUsed]

A flow converting a flat stream of quad statements into a stream of RdfStreamFrames. Physical stream type: QUADS. Logical stream type (RDF-STaX): flat RDF quad stream (FLAT_QUADS).

A flow converting a flat stream of quad statements into a stream of RdfStreamFrames. Physical stream type: QUADS. Logical stream type (RDF-STaX): flat RDF quad stream (FLAT_QUADS).

This flow will wait for enough items to fill the whole gRPC message, which increases latency. To mitigate that, use the flatQuadStreamGrouped method instead.

Type parameters

TQuad

Type of quad statements.

Value parameters

factory

Implementation of ConverterFactory (e.g., JenaConverterFactory).

limiter

frame size limiter (see SizeLimiter)

opt

Jelly serialization options.

Attributes

Returns

Pekko Streams flow.

final def flatQuadStreamGrouped[TQuad](maybeLimiter: Option[SizeLimiter], opt: RdfStreamOptions)(using factory: ConverterFactory[_, _, _, _, _, TQuad]): Flow[IterableOnce[TQuad], RdfStreamFrame, NotUsed]

A flow converting a stream of iterables with quad statements into a stream of RdfStreamFrames. Physical stream type: QUADS. Logical stream type (RDF-STaX): flat RDF quad stream (FLAT_QUADS).

A flow converting a stream of iterables with quad statements into a stream of RdfStreamFrames. Physical stream type: QUADS. Logical stream type (RDF-STaX): flat RDF quad stream (FLAT_QUADS).

After this flow finishes processing an iterable in the input stream, it is guaranteed to output an RdfStreamFrame, which allows to maintain low latency.

Type parameters

TQuad

Type of quad statements.

Value parameters

factory

Implementation of ConverterFactory (e.g., JenaConverterFactory).

maybeLimiter

frame size limiter (see SizeLimiter). If None, no size limit is applied (frames are only split by groups).

opt

Jelly serialization options.

Attributes

Returns

Pekko Streams flow.

final def flatTripleStream[TTriple](limiter: SizeLimiter, opt: RdfStreamOptions)(using factory: ConverterFactory[_, _, _, _, TTriple, _]): Flow[TTriple, RdfStreamFrame, NotUsed]

A flow converting a flat stream of triple statements into a stream of RdfStreamFrames. Physical stream type: TRIPLES. Logical stream type (RDF-STaX): flat RDF triple stream (FLAT_TRIPLES).

A flow converting a flat stream of triple statements into a stream of RdfStreamFrames. Physical stream type: TRIPLES. Logical stream type (RDF-STaX): flat RDF triple stream (FLAT_TRIPLES).

This flow will wait for enough items to fill the whole gRPC message, which increases latency. To mitigate that, use the flatTripleStreamGrouped method instead.

Type parameters

TTriple

Type of triple statements.

Value parameters

factory

Implementation of ConverterFactory (e.g., JenaConverterFactory).

limiter

frame size limiter (see SizeLimiter).

opt

Jelly serialization options.

Attributes

Returns

Pekko Streams flow.

final def flatTripleStreamGrouped[TTriple](maybeLimiter: Option[SizeLimiter], opt: RdfStreamOptions)(using factory: ConverterFactory[_, _, _, _, TTriple, _]): Flow[IterableOnce[TTriple], RdfStreamFrame, NotUsed]

A flow converting a stream of iterables with triple statements into a stream of RdfStreamFrames. Physical stream type: TRIPLES. Logical stream type (RDF-STaX): flat RDF triple stream (FLAT_TRIPLES).

A flow converting a stream of iterables with triple statements into a stream of RdfStreamFrames. Physical stream type: TRIPLES. Logical stream type (RDF-STaX): flat RDF triple stream (FLAT_TRIPLES).

After this flow finishes processing an iterable in the input stream, it is guaranteed to output an RdfStreamFrame, which allows to maintain low latency.

Type parameters

TTriple

Type of triple statements.

Value parameters

factory

Implementation of ConverterFactory (e.g., JenaConverterFactory).

maybeLimiter

frame size limiter (see SizeLimiter). If None, no size limit is applied (frames are only split by groups).

opt

Jelly serialization options.

Attributes

Returns

Pekko Streams flow.

final def graphStream[TTriple](maybeLimiter: Option[SizeLimiter], opt: RdfStreamOptions)(using factory: ConverterFactory[_, _, _, _, TTriple, _]): Flow[IterableOnce[TTriple], RdfStreamFrame, NotUsed]

A flow converting a stream of graphs (iterables with triple statements) into a stream of RdfStreamFrames. Physical stream type: TRIPLES. Logical stream type (RDF-STaX): RDF graph stream (GRAPHS).

A flow converting a stream of graphs (iterables with triple statements) into a stream of RdfStreamFrames. Physical stream type: TRIPLES. Logical stream type (RDF-STaX): RDF graph stream (GRAPHS).

Each graph (iterable of triples) in the input stream is guaranteed to correspond to exactly one RdfStreamFrame in the output stream IF no frame size limiter is applied.

Type parameters

TTriple

Type of triple statements.

Value parameters

factory

Implementation of ConverterFactory (e.g., JenaConverterFactory).

maybeLimiter

frame size limiter (see SizeLimiter). If None, no size limit is applied (frames are only split by graphs).

opt

Jelly serialization options.

Attributes

Returns

Pekko Streams flow.

final def namedGraphStream[TNode, TTriple](maybeLimiter: Option[SizeLimiter], opt: RdfStreamOptions)(using factory: ConverterFactory[_, _, TNode, _, TTriple, _]): Flow[(TNode, Iterable[TTriple]), RdfStreamFrame, NotUsed]

A flow converting a stream of named or unnamed graphs (node as graph name + iterable of triple statements) into a stream of RdfStreamFrames. Each element in the output stream may contain one graph or a part of a graph (if the frame size limiter is used). Two different graphs will never occur in the same frame. Physical stream type: GRAPHS. Logical stream type (RDF-STaX): RDF named graph stream (NAMED_GRAPHS).

A flow converting a stream of named or unnamed graphs (node as graph name + iterable of triple statements) into a stream of RdfStreamFrames. Each element in the output stream may contain one graph or a part of a graph (if the frame size limiter is used). Two different graphs will never occur in the same frame. Physical stream type: GRAPHS. Logical stream type (RDF-STaX): RDF named graph stream (NAMED_GRAPHS).

Each graph in the input stream is guaranteed to correspond to exactly one RdfStreamFrame in the output stream IF no frame size limiter is applied.

Type parameters

TNode

Type of nodes.

TTriple

Type of triple statements.

Value parameters

factory

Implementation of ConverterFactory (e.g., JenaConverterFactory).

maybeLimiter

frame size limiter (see SizeLimiter). If None, no size limit is applied (frames are only split by graphs).

opt

Jelly serialization options.

Attributes

Returns

Pekko Streams flow.

Generated with