org.protempa

Class AlgorithmSourceImpl

java.lang.Object

org.protempa.AbstractSource<AlgorithmSourceUpdatedEvent,AlgorithmSourceBackend,AlgorithmSourceUpdatedEvent,AlgorithmSourceBackendUpdatedEvent>

org.protempa.AlgorithmSourceImpl

All Implemented Interfaces:

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

public final class AlgorithmSourceImpl
extends AbstractSource<AlgorithmSourceUpdatedEvent,AlgorithmSourceBackend,AlgorithmSourceUpdatedEvent,AlgorithmSourceBackendUpdatedEvent>
implements AlgorithmSource

A read-only "interface" to an externally maintained set of pattern detection algorithm implementations. Backends implementing AlgorithmSourceBackend provide implementations of the actual algorithms available.

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
AlgorithmSourceImpl(AlgorithmSourceBackend[] backends) Constructor for specifying a mix of AlgorithmSourceBackends and Properties objects specifying algorithm source backends.

Method Summary

Modifier and Type	Method and Description
void	backendUpdated(AlgorithmSourceBackendUpdatedEvent event) Notifies a listener when it needs to reread data in the backend.
void	clear()
void	close() Removes this Source as a listener to the Backends provided to the constructor.
Algorithm	readAlgorithm(String id) Read an algorithm with the given id.
Set<Algorithm>	readAlgorithms() Reads all algorithms in this algorithm source.

Methods inherited from class org.protempa.AbstractSource

addSourceListener, fireClosedUnexpectedly, fireSourceUpdated, getBackends, isClosed, removeSourceListener, setEventListeners, unrecoverableErrorOccurred

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.protempa.Source

addSourceListener, getBackends, removeSourceListener, setEventListeners

Methods inherited from interface org.protempa.BackendListener

unrecoverableErrorOccurred

Constructor Detail

AlgorithmSourceImpl

public AlgorithmSourceImpl(AlgorithmSourceBackend[] backends)

Constructor for specifying a mix of AlgorithmSourceBackends and Properties objects specifying algorithm source backends.

Parameters:

backends - an array of AlgorithmSourceBackend.

Method Detail

readAlgorithm

public Algorithm readAlgorithm(String id)
                        throws AlgorithmSourceReadException

Read an algorithm with the given id.

Specified by:

readAlgorithm in interface AlgorithmSource

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

public Set<Algorithm> readAlgorithms()
                              throws AlgorithmSourceReadException

Reads all algorithms in this algorithm source.

Specified by:

readAlgorithms in interface AlgorithmSource

Returns:

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

Throws:

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

close

public void close()
           throws SourceCloseException

Description copied from class: AbstractSource

Removes this Source as a listener to the Backends provided to the constructor. Must be called by subclasses, or proper cleanup will not occur.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Source<AlgorithmSourceUpdatedEvent,AlgorithmSourceBackend,AlgorithmSourceBackendUpdatedEvent>

Overrides:

close in class AbstractSource<AlgorithmSourceUpdatedEvent,AlgorithmSourceBackend,AlgorithmSourceUpdatedEvent,AlgorithmSourceBackendUpdatedEvent>

Throws:

SourceCloseException

clear

public void clear()

Specified by:

clear in interface Source<AlgorithmSourceUpdatedEvent,AlgorithmSourceBackend,AlgorithmSourceBackendUpdatedEvent>

backendUpdated

public void backendUpdated(AlgorithmSourceBackendUpdatedEvent event)

Description copied from interface: BackendListener

Notifies a listener when it needs to reread data in the backend.

Specified by:

backendUpdated in interface BackendListener<AlgorithmSourceBackendUpdatedEvent>

Parameters:

event - an EventObject