org.protempa.backend

Class AbstractBackend<E extends BackendUpdatedEvent>

java.lang.Object

org.protempa.backend.AbstractBackend<E>

Type Parameters:

E - the BackendUpdatedEvent that this backend fires.

All Implemented Interfaces:

Backend<E>

Direct Known Subclasses:

AbstractAlgorithmSourceBackend, AbstractDataSourceBackend, AbstractKnowledgeSourceBackend, AbstractTermSourceBackend

public abstract class AbstractBackend<E extends BackendUpdatedEvent>
extends Object
implements Backend<E>

Common interface for PROTEMPA backends.

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
AbstractBackend()

Method Summary

Modifier and Type	Method and Description
void	addBackendListener(BackendListener<E> listener) Registers a listener that get called whenever a backend changes.
protected void	fireBackendUpdated(E e) Notifies all registered listeners when the backend has been updated.
protected void	fireEvent(ProtempaEvent evt)
protected void	fireUnrecoverableError(UnrecoverableBackendErrorEvent e) Notifies all registered listeners when an unrecoverable error has occurred in a backend.
String	getConfigurationsId()
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)
void	setId(String id)

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

close, getDisplayName

Constructor Detail

AbstractBackend

public AbstractBackend()

Method Detail

initialize

public void initialize(BackendInstanceSpec<?> config)
                throws BackendInitializationException

Description copied from interface: Backend

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.

Specified by:

initialize in interface Backend<E extends BackendUpdatedEvent>

Parameters:

config - the configuration Properties object.

Throws:

BackendInitializationException

getId

public String getId()

Specified by:

getId in interface Backend<E extends BackendUpdatedEvent>

setId

public void setId(String id)

getConfigurationsId

public String getConfigurationsId()

Specified by:

getConfigurationsId in interface Backend<E extends BackendUpdatedEvent>

addBackendListener

public void addBackendListener(BackendListener<E> listener)

Description copied from interface: Backend

Registers a listener that get called whenever a backend changes.

Specified by:

addBackendListener in interface Backend<E extends BackendUpdatedEvent>

Parameters:

listener - a BackendListener.

removeBackendListener

public void removeBackendListener(BackendListener<E> listener)

Description copied from interface: Backend

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

Specified by:

removeBackendListener in interface Backend<E extends BackendUpdatedEvent>

Parameters:

listener - a BackendListener.

setEventListeners

public void setEventListeners(List<? extends ProtempaEventListener> eventListeners)

Specified by:

setEventListeners in interface Backend<E extends BackendUpdatedEvent>

fireEvent

protected void fireEvent(ProtempaEvent evt)

fireBackendUpdated

protected void fireBackendUpdated(E e)

Notifies all registered listeners when the backend has been updated.

Parameters:

e - a BackendUpdatedEvent representing an update.

fireUnrecoverableError

protected void fireUnrecoverableError(UnrecoverableBackendErrorEvent e)

Notifies all registered listeners when an unrecoverable error has occurred in a backend.

Parameters:

e - a UnrecoverableBackendErrorEvent representing the cause of the error.