org.protempa.backend

Interface Backend<E extends BackendUpdatedEvent>

Type Parameters:

E - the BackendUpdatedEvent that this backend fires.

S - this backend's corresponding Source.

All Known Subinterfaces:

AlgorithmSourceBackend, DataSourceBackend, KnowledgeSourceBackend, TermSourceBackend

All Known Implementing Classes:

AbstractAlgorithmSourceBackend, AbstractBackend, AbstractCommonsAlgorithmSourceBackend, AbstractCommonsDataSourceBackend, AbstractCommonsKnowledgeSourceBackend, AbstractCommonsTermSourceBackend, AbstractDataSourceBackend, AbstractJavaAlgorithmBackend, AbstractKnowledgeSourceBackend, AbstractTermSourceBackend, JavaAlgorithmBackend, MockTermSourceBackend, SimpleKnowledgeSourceBackend

public interface Backend<E extends BackendUpdatedEvent>

Common interface for PROTEMPA backends.

Author:

Andrew Post

Method Summary

Modifier and Type	Method and Description
void	addBackendListener(BackendListener<E> listener) Registers a listener that get called whenever a backend changes.
void	close() Releases any resources allocated by this backend.
String	getConfigurationsId()
String	getDisplayName() Returns the name of this backend for display in user interfaces.
String	getId()
void	initialize(BackendInstanceSpec<?> config) Initializes the backend from a BackendInstanceSpec.
void	removeBackendListener(BackendListener<E> listener) Unregisters a listener so that changes to the backend are no longer sent.
void	setEventListeners(List<? extends ProtempaEventListener> eventListeners)

Method Detail

initialize

void initialize(BackendInstanceSpec<?> config)
         throws BackendInitializationException

Initializes the backend from a BackendInstanceSpec. It is called for you by BackendInstanceSpec.getInstance(), but if you create a Backend object yourself, you must call this manually before using it.

Parameters:

source - the backend's corresponding Source instance.

config - the configuration Properties object.

Throws:

BackendInitializationException

getDisplayName

String getDisplayName()

Returns the name of this backend for display in user interfaces.

Returns:

a String.

getConfigurationsId

String getConfigurationsId()

getId

String getId()

close

void close()
    throws BackendCloseException

Releases any resources allocated by this backend.

Throws:

BackendCloseException

addBackendListener

void addBackendListener(BackendListener<E> listener)

Registers a listener that get called whenever a backend changes.

Parameters:

listener - a BackendListener.

removeBackendListener

void removeBackendListener(BackendListener<E> listener)

Unregisters a listener so that changes to the backend are no longer sent.

Parameters:

listener - a BackendListener.

setEventListeners

void setEventListeners(List<? extends ProtempaEventListener> eventListeners)