org.protempa

Interface AlgorithmSource

All Superinterfaces:

AutoCloseable, BackendListener<AlgorithmSourceBackendUpdatedEvent>, EventListener, Source<AlgorithmSourceUpdatedEvent,AlgorithmSourceBackend,AlgorithmSourceBackendUpdatedEvent>

All Known Implementing Classes:

AlgorithmSourceImpl

public interface AlgorithmSource
extends Source<AlgorithmSourceUpdatedEvent,AlgorithmSourceBackend,AlgorithmSourceBackendUpdatedEvent>

Author:

Andrew Post

Method Summary

Modifier and Type	Method and Description
Algorithm	readAlgorithm(String id) Read an algorithm with the given id.
Set<Algorithm>	readAlgorithms() Reads all algorithms in this algorithm source.

Methods inherited from interface org.protempa.Source

addSourceListener, clear, close, getBackends, removeSourceListener, setEventListeners

Methods inherited from interface org.protempa.BackendListener

backendUpdated, unrecoverableErrorOccurred

Method Detail

readAlgorithm

Algorithm readAlgorithm(String id)
                 throws AlgorithmSourceReadException

Read an algorithm with the given id.

Parameters:

id - an algorithm id String.

Returns:

an Algorithm object, or null if no algorithm with the specified id exists. If a null id is * specified, null is returned.

Throws:

AlgorithmSourceReadException - when an error occurs in a backend reading the specified algorithm.

readAlgorithms

Set<Algorithm> readAlgorithms()
                       throws AlgorithmSourceReadException

Reads all algorithms in this algorithm source.

Returns:

an unmodifiable Set of Algorithm objects. Guaranteed not to return null.

Throws:

AlgorithmSourceReadException - when an error occurs in a backend reading an algorithm.