Package de.iip_ecosphere.platform.services.environment.services

Class FixedRateSource<D>

java.lang.Object

de.iip_ecosphere.platform.services.environment.services.FixedRateSource<D>

Type Parameters:

D - the data handled by the source

Direct Known Subclasses:

FixedRateSource.TransportFixedRateSource

public abstract class FixedRateSource<D>
extends Object

A fixed rate source for experiments. May be used in a service, may be used standalone.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FixedRateSource.FixedRateParams	A parameter/configuration object for the FixedRateSource.
static class	FixedRateSource.TransportFixedRateSource<D>	Specializes the fixed-rate source for TransportConnector.

Field Summary

Fields

Modifier and Type	Field	Description
private Supplier<D>	dataCreator
private DataIngestor<D>	ingestor
private FixedRateSource.FixedRateParams	params
private Supplier<ServiceState>	stateSupplier
private Timer	timer

Constructor Summary

Constructors

Constructor	Description
FixedRateSource(Supplier<D> dataCreator, FixedRateSource.FixedRateParams params)	Creates a fixed-rate source.
FixedRateSource(Supplier<D> dataCreator, FixedRateSource.FixedRateParams params, DataIngestor<D> ingestor, Supplier<ServiceState> stateSupplier)	Creates a fixed-rate source.

Method Summary

Modifier and Type	Method	Description
protected abstract void	disconnect()	Called to disconnect from the ingestor.
protected abstract boolean	doStartExperiment()	Shall the run/experiment be started by this instance.
protected void	ingest(D data)	Is called to ingest data provided by dataCreator.
static <D> DataIngestor<D>	noIngestor()	Creates a no-ingestor that ignores data.
protected abstract void	notifySent()	Notifies that data has been sent.
protected abstract void	notifyStarting()	Notifies about starting the run/experiment.
protected abstract void	notifyStopping()	Notifies about stopping the run/experiment.
static Supplier<ServiceState>	runningState()	Creates a standard running state supplier.
protected void	setIngestor(DataIngestor<D> ingestor)	Changes the ingestor.
void	start()	Starts the source, if enabled starting/stopping the experiment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

timer

private Timer timer

dataCreator

private Supplier<D> dataCreator

params

private FixedRateSource.FixedRateParams params

ingestor

private DataIngestor<D> ingestor

stateSupplier

private Supplier<ServiceState> stateSupplier

Constructor Details

FixedRateSource

public FixedRateSource(Supplier<D> dataCreator,
 FixedRateSource.FixedRateParams params)

Creates a fixed-rate source.

Parameters:

dataCreator - a supplier creating the data

params - the parameter/configuration object

FixedRateSource

public FixedRateSource(Supplier<D> dataCreator,
 FixedRateSource.FixedRateParams params,
 DataIngestor<D> ingestor,
 Supplier<ServiceState> stateSupplier)

Creates a fixed-rate source.

Parameters:

dataCreator - a supplier creating the data

params - the parameter/configuration object

ingestor - data ingestor

stateSupplier - service state supplier

Method Details

noIngestor

public static <D> DataIngestor<D> noIngestor()

Creates a no-ingestor that ignores data.

Type Parameters:

D - the type of data

Returns:

the ingestor

runningState

public static Supplier<ServiceState> runningState()

Creates a standard running state supplier.

Returns:

the supplier

setIngestor

protected void setIngestor(DataIngestor<D> ingestor)

Changes the ingestor.

Parameters:

ingestor - the new ingestor

start

public void start()

Starts the source, if enabled starting/stopping the experiment.

doStartExperiment

protected abstract boolean doStartExperiment()

Shall the run/experiment be started by this instance.

Returns:

true for starting, false for not starting

notifyStarting

protected abstract void notifyStarting()

Notifies about starting the run/experiment.

notifyStopping

protected abstract void notifyStopping()

Notifies about stopping the run/experiment.

notifySent

protected abstract void notifySent()

Notifies that data has been sent.

ingest

protected void ingest(D data)
               throws IOException

Is called to ingest data provided by dataCreator.

Parameters:

data - the data

Throws:

IOException - if ingesting fails

disconnect

protected abstract void disconnect()
                            throws IOException

Called to disconnect from the ingestor.

Throws:

IOException - if disconnecting fails