org.protempa.backend.asb.java

Class AbstractJavaAlgorithmBackend

java.lang.Object

org.protempa.backend.AbstractBackend<AlgorithmSourceBackendUpdatedEvent>

org.protempa.backend.asb.AbstractAlgorithmSourceBackend

org.protempa.backend.asb.java.AbstractJavaAlgorithmBackend

All Implemented Interfaces:

AlgorithmSourceBackend, Backend<AlgorithmSourceBackendUpdatedEvent>

Direct Known Subclasses:

JavaAlgorithmBackend

public abstract class AbstractJavaAlgorithmBackend
extends AbstractAlgorithmSourceBackend

For accessing algorithms written in Java as subclasses of AbstractAlgorithm.

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
AbstractJavaAlgorithmBackend()
AbstractJavaAlgorithmBackend(BackendInstanceSpec config)

Method Summary

Modifier and Type	Method and Description
void	close() Implemented as a no-op.
protected Class<?>	getAlgorithmClass(String name) name is expected to be a fully-qualified class name in dot-format (e.g., my.algorithms.MockAlgorithm).
protected String	getAlgorithmsPropertiesResourceName()
void	initialize(BackendInstanceSpec config) Reads the properties file containing the list of algorithm classes.
Algorithm	readAlgorithm(String id, Algorithms algorithms) Reads an algorithm from this backend.
void	readAlgorithms(Algorithms algorithms) Read the available algorithms.

Methods inherited from class org.protempa.backend.asb.AbstractAlgorithmSourceBackend

fireAlgorithmSourceBackendUpdated

Methods inherited from class org.protempa.backend.AbstractBackend

addBackendListener, fireBackendUpdated, fireEvent, fireUnrecoverableError, getConfigurationsId, getId, removeBackendListener, setEventListeners, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.protempa.backend.Backend

addBackendListener, getConfigurationsId, getDisplayName, getId, removeBackendListener, setEventListeners

Constructor Detail

AbstractJavaAlgorithmBackend

public AbstractJavaAlgorithmBackend()

AbstractJavaAlgorithmBackend

public AbstractJavaAlgorithmBackend(BackendInstanceSpec config)

Method Detail

getAlgorithmsPropertiesResourceName

protected String getAlgorithmsPropertiesResourceName()

initialize

public final void initialize(BackendInstanceSpec config)
                      throws BackendInitializationException

Reads the properties file containing the list of algorithm classes.

Specified by:

initialize in interface Backend<AlgorithmSourceBackendUpdatedEvent>

Overrides:

initialize in class AbstractBackend<AlgorithmSourceBackendUpdatedEvent>

Parameters:

config - the configuration Properties object.

Throws:

BackendInitializationException

readAlgorithm

public final Algorithm readAlgorithm(String id,
                                     Algorithms algorithms)
                              throws AlgorithmSourceReadException

Description copied from interface: AlgorithmSourceBackend

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.

getAlgorithmClass

protected Class<?> getAlgorithmClass(String name)
                              throws Exception

name is expected to be a fully-qualified class name in dot-format (e.g., my.algorithms.MockAlgorithm).

Parameters:

name -

Returns:

Throws:

Exception

readAlgorithms

public final void readAlgorithms(Algorithms algorithms)
                          throws AlgorithmSourceReadException

Description copied from interface: AlgorithmSourceBackend

Read the available algorithms.

Parameters:

algorithms - an Algorithms object.

Throws:

AlgorithmSourceReadException - when an error occurs reading an algorithm.

close

public void close()

Description copied from class: AbstractAlgorithmSourceBackend

Implemented as a no-op.

Specified by:

close in interface Backend<AlgorithmSourceBackendUpdatedEvent>

Overrides:

close in class AbstractAlgorithmSourceBackend

See Also:

org.protempa.AlgorithmSourceBackend#close()