org.protempa

Class AbstractSource<S extends SourceUpdatedEvent,B extends Backend,E extends SourceUpdatedEvent,T extends BackendUpdatedEvent>

java.lang.Object

org.protempa.AbstractSource<S,B,E,T>

All Implemented Interfaces:

AutoCloseable, EventListener, BackendListener<T>, Source<S,B,T>

Direct Known Subclasses:

AlgorithmSourceImpl, DataSourceImpl, KnowledgeSourceImpl, TermSourceImpl

public abstract class AbstractSource<S extends SourceUpdatedEvent,B extends Backend,E extends SourceUpdatedEvent,T extends BackendUpdatedEvent>
extends Object
implements Source<S,B,T>

Method Summary

Modifier and Type	Method and Description
void	addSourceListener(SourceListener<S> listener) Adds a listener that gets called whenever something changes.
void	close() Removes this Source as a listener to the Backends provided to the constructor.
protected void	fireClosedUnexpectedly(SourceClosedUnexpectedlyEvent<S,B,T> e)
protected void	fireSourceUpdated(S e) Notifies registered listeners that the source has been updated.
B[]	getBackends() Gets the backends registered to this source.
protected boolean	isClosed()
void	removeSourceListener(SourceListener<S> listener) Removes a listener so that changes to the source are no longer sent.
void	unrecoverableErrorOccurred(UnrecoverableBackendErrorEvent e) Some unrecoverable error occurred while using a backend module, like a connection to a server was lost.

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

clear

Methods inherited from interface org.protempa.BackendListener

backendUpdated

Method Detail

getBackends

public final B[] getBackends()

Gets the backends registered to this source.

Specified by:

getBackends in interface Source<S extends SourceUpdatedEvent,B extends Backend,T extends BackendUpdatedEvent>

Returns:

an array of backends. Guaranteed not null.

addSourceListener

public final void addSourceListener(SourceListener<S> listener)

Adds a listener that gets called whenever something changes.

Specified by:

addSourceListener in interface Source<S extends SourceUpdatedEvent,B extends Backend,T extends BackendUpdatedEvent>

Parameters:

listener - a DataSourceListener.

removeSourceListener

public final void removeSourceListener(SourceListener<S> listener)

Removes a listener so that changes to the source are no longer sent.

Specified by:

removeSourceListener in interface Source<S extends SourceUpdatedEvent,B extends Backend,T extends BackendUpdatedEvent>

Parameters:

listener - a DataSourceListener.

fireSourceUpdated

protected void fireSourceUpdated(S e)

Notifies registered listeners that the source has been updated.

Parameters:

e - a SourceUpdatedEvent representing an update.

See Also:

SourceListener

fireClosedUnexpectedly

protected void fireClosedUnexpectedly(SourceClosedUnexpectedlyEvent<S,B,T> e)

close

public void close()
           throws SourceCloseException

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<S extends SourceUpdatedEvent,B extends Backend,T extends BackendUpdatedEvent>

Throws:

SourceCloseException

isClosed

protected boolean isClosed()

unrecoverableErrorOccurred

public final void unrecoverableErrorOccurred(UnrecoverableBackendErrorEvent e)

Description copied from interface: BackendListener

Some unrecoverable error occurred while using a backend module, like a connection to a server was lost.

Specified by:

unrecoverableErrorOccurred in interface BackendListener<T extends BackendUpdatedEvent>

Parameters:

e - a UnrecoverableBackendErrorEvent.