com.speedment.runtime.core.component

Interface StreamSupplierComponent

All Known Subinterfaces:

SqlStreamSupplierComponent

public interface StreamSupplierComponent

This Component interface is used to obtain streams for different tables.

Since:

2.2.0

Author:

Per Minborg

Method Summary

Modifier and Type	Method and Description
default <ENTITY,V extends Comparable<? super V>> Optional<ENTITY>	findAny(com.speedment.runtime.config.identifier.TableIdentifier<ENTITY> tableIdentifier, com.speedment.runtime.field.trait.HasComparableOperators<ENTITY,V> field, V value) Finds a particular entity in the source where the specified field has the specified value.
default boolean	isImmutable() Returns if this stream component will return the same stream result over time (immutable or analytics type of data).
default Stream<StreamSupplierComponent>	sourceStreamSupplierComponents() Creates and returns a new Stream of underlying StreamSupplierComponent objects that provides data to this StreamSupplierComponent.
default void	start() Starts the stream suppler and initialized any resources needed for its operation.
default void	stop() Stops the stream suppler and releases any previously allocated resources.
default <ENTITY> Stream<ENTITY>	stream(com.speedment.runtime.config.identifier.TableIdentifier<ENTITY> tableId) Basic stream over all entities using the default ParallelStrategy.
<ENTITY> Stream<ENTITY>	stream(com.speedment.runtime.config.identifier.TableIdentifier<ENTITY> tableIdentifier, ParallelStrategy strategy) Basic stream over all entities.

Method Detail

stream

default <ENTITY> Stream<ENTITY> stream(com.speedment.runtime.config.identifier.TableIdentifier<ENTITY> tableId)

Basic stream over all entities using the default ParallelStrategy.

Type Parameters:

ENTITY - entity type

Parameters:

tableId - the identifier to use

Returns:

a stream for the given entity class

Since:

3.0.15

stream

<ENTITY> Stream<ENTITY> stream(com.speedment.runtime.config.identifier.TableIdentifier<ENTITY> tableIdentifier,
                               ParallelStrategy strategy)

Basic stream over all entities.

Type Parameters:

ENTITY - entity type

Parameters:

tableIdentifier - the identifier to use

strategy - decorates the stream before building it

Returns:

a stream for the given entity class

findAny

default <ENTITY,V extends Comparable<? super V>> Optional<ENTITY> findAny(com.speedment.runtime.config.identifier.TableIdentifier<ENTITY> tableIdentifier,
                                                                          com.speedment.runtime.field.trait.HasComparableOperators<ENTITY,V> field,
                                                                          V value)

Finds a particular entity in the source where the specified field has the specified value. This is a form of key-value lookup than can potentially be more efficient with for an example foreign key references.

Type Parameters:

ENTITY - the entity type

V - the java type of the column

Parameters:

tableIdentifier - the identifier to use

field - the field to select on

value - the value of that field for the entity to return

Returns:

entity found or empty if none existed with that value

isImmutable

default boolean isImmutable()

Returns if this stream component will return the same stream result over time (immutable or analytics type of data).

Returns:

true if the source is immutable

start

default void start()

Starts the stream suppler and initialized any resources needed for its operation.

stop

default void stop()

Stops the stream suppler and releases any previously allocated resources.

sourceStreamSupplierComponents

default Stream<StreamSupplierComponent> sourceStreamSupplierComponents()

Creates and returns a new Stream of underlying StreamSupplierComponent objects that provides data to this StreamSupplierComponent. If no such component exists (i.e. the component draws data only from external sources like databases or files) an empty stream is returned.

Returns:

a new Stream of underlying StreamSupplierComponent objects that provides data to this StreamSupplierComponent