org.protempa.backend.asb

Interface AlgorithmSourceBackend

All Superinterfaces:

Backend<AlgorithmSourceBackendUpdatedEvent>

All Known Implementing Classes:

AbstractAlgorithmSourceBackend, AbstractCommonsAlgorithmSourceBackend, AbstractJavaAlgorithmBackend, JavaAlgorithmBackend

public interface AlgorithmSourceBackend
extends Backend<AlgorithmSourceBackendUpdatedEvent>

A set of algorithms for use in PROTEMPA pattern detection.

Author:

Andrew

Method Summary

Modifier and Type	Method and Description
Algorithm	readAlgorithm(String id, Algorithms algorithms) Reads an algorithm from this backend.
void	readAlgorithms(Algorithms algorithms) Read the available algorithms.

Methods inherited from interface org.protempa.backend.Backend

addBackendListener, close, getConfigurationsId, getDisplayName, getId, initialize, removeBackendListener, setEventListeners

Method Detail

readAlgorithm

Algorithm readAlgorithm(String id,
                        Algorithms algorithms)
                 throws AlgorithmSourceReadException

Reads an algorithm from this backend.

Parameters:

id - an algorithm id String.

algorithms - an Algorithms object.

Returns:

an Algorithm object or null if an algorithm with the given id was not found.

Throws:

AlgorithmSourceReadException - when an error occurs reading the specified algorithm.

readAlgorithms

void readAlgorithms(Algorithms algorithms)
             throws AlgorithmSourceReadException

Read the available algorithms.

Parameters:

algorithms - an Algorithms object.

Throws:

AlgorithmSourceReadException - when an error occurs reading an algorithm.