org.youscope.common.resource

Class ResourceAdapter<C extends ResourceConfiguration>

java.lang.Object

org.youscope.common.resource.ResourceAdapter<C>

Type Parameters:

C -

All Implemented Interfaces:

java.rmi.Remote, Component, Resource

Direct Known Subclasses:

StandardSaveSettings

public abstract class ResourceAdapter<C extends ResourceConfiguration>
extends java.lang.Object
implements Resource

Adapter to simplify resource creation.

Author:

Moritz Lang

Constructor Summary

Constructors

Constructor and Description
ResourceAdapter(PositionInformation positionInformation, ResourceConfiguration configuration, java.lang.String typeIdentifier, java.lang.Class<C> configurationClass, java.lang.String defaultName) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addMessageListener(MessageListener writer) Adds a message listener to which (non-error) status information is send.
protected void	assertInitialized()
protected C	getConfiguration()
java.lang.String	getName() Returns a name of the component meant for human interpretation.
PositionInformation	getPositionInformation() Returns the component's position information, e.g.
java.lang.String	getTypeIdentifier() Returns the type identifier of the resource.
java.util.UUID	getUUID() Returns a unique ID of the component.
void	initialize(MeasurementContext measurementContext) Initializes the resource.
boolean	isInitialized() Returns true if the addon is initialized.
void	removeMessageListener(MessageListener writer) Removes a previously added listener.
protected void	sendErrorMessage(java.lang.String message, java.lang.Throwable error) Sends an error message to all registered listeners.
protected void	sendMessage(java.lang.String message) Sends a message to all registered listeners.
void	setName(java.lang.String name) Sets the name of the component meant for human interpretation.
void	uninitialize(MeasurementContext measurementContext) Called to free all acquired resources of the addon.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceAdapter

public ResourceAdapter(PositionInformation positionInformation,
                       ResourceConfiguration configuration,
                       java.lang.String typeIdentifier,
                       java.lang.Class<C> configurationClass,
                       java.lang.String defaultName)
                throws ConfigurationException

Constructor.

Parameters:

positionInformation - logical position in measurement.

configuration - Configuration of resource.

typeIdentifier - type identifier of resource.

configurationClass -

defaultName -

Throws:

ConfigurationException

Method Detail

addMessageListener

public void addMessageListener(MessageListener writer)
                        throws java.rmi.RemoteException

Description copied from interface: Component

Adds a message listener to which (non-error) status information is send.

Specified by:

addMessageListener in interface Component

Parameters:

writer - Listener to which output should be written.

Throws:

java.rmi.RemoteException

removeMessageListener

public void removeMessageListener(MessageListener writer)
                           throws java.rmi.RemoteException

Description copied from interface: Component

Removes a previously added listener.

Specified by:

removeMessageListener in interface Component

Parameters:

writer - Listener which should be removed.

Throws:

java.rmi.RemoteException

sendMessage

protected void sendMessage(java.lang.String message)

Sends a message to all registered listeners.

Parameters:

message - Message to send.

sendErrorMessage

protected void sendErrorMessage(java.lang.String message,
                                java.lang.Throwable error)

Sends an error message to all registered listeners.

Parameters:

message - Error message to send.

error - The error which occurred.

getTypeIdentifier

public java.lang.String getTypeIdentifier()
                                   throws java.rmi.RemoteException

Description copied from interface: Resource

Returns the type identifier of the resource.

Specified by:

getTypeIdentifier in interface Resource

Returns:

Type identifier of the resource

Throws:

java.rmi.RemoteException

initialize

public void initialize(MeasurementContext measurementContext)
                throws ResourceException,
                       java.rmi.RemoteException

Description copied from interface: Resource

Initializes the resource. Must be called before calling any resource functions except getTypeIdentifier, getConfigurationClass, isInitialized, addDetectionOutputWriter, or removeMessageListener.

Specified by:

initialize in interface Resource

Parameters:

measurementContext - The measurement context.

Throws:

ResourceException

java.rmi.RemoteException

uninitialize

public void uninitialize(MeasurementContext measurementContext)
                  throws ResourceException,
                         java.rmi.RemoteException

Description copied from interface: Resource

Called to free all acquired resources of the addon. This function may be called more than once, or without calling initialize a priori.

Specified by:

uninitialize in interface Resource

Parameters:

measurementContext - The measurement context.

Throws:

ResourceException

java.rmi.RemoteException

isInitialized

public boolean isInitialized()
                      throws java.rmi.RemoteException

Description copied from interface: Resource

Returns true if the addon is initialized.

Specified by:

isInitialized in interface Resource

Returns:

True if initialized, otherwise false.

Throws:

java.rmi.RemoteException

getConfiguration

protected C getConfiguration()

assertInitialized

protected void assertInitialized()
                          throws ResourceException,
                                 java.rmi.RemoteException

Throws:

ResourceException

java.rmi.RemoteException

getPositionInformation

public PositionInformation getPositionInformation()
                                           throws java.rmi.RemoteException

Description copied from interface: Component

Returns the component's position information, e.g. in which well, tile, or z-stack location it is.

Specified by:

getPositionInformation in interface Component

Returns:

Position information vector.

Throws:

java.rmi.RemoteException

getName

public java.lang.String getName()
                         throws java.rmi.RemoteException

Description copied from interface: Component

Returns a name of the component meant for human interpretation.

Specified by:

getName in interface Component

Returns:

Name/short description of component.

Throws:

java.rmi.RemoteException

setName

public void setName(java.lang.String name)
             throws java.rmi.RemoteException

Description copied from interface: Component

Sets the name of the component meant for human interpretation. Usually, the default name of a component contains already sufficient information. However, for some measurement types it can be of advantage to rename certain components which have a specific meaning for the respective measurement.

Specified by:

setName in interface Component

Parameters:

name - Name/short description of the component.

Throws:

java.rmi.RemoteException

getUUID

public java.util.UUID getUUID()
                       throws java.rmi.RemoteException

Description copied from interface: Component

Returns a unique ID of the component. No two components have the same unique ID, even if they are created using the same configuration. See UUID.equals(Object) and UUID.randomUUID().

Specified by:

getUUID in interface Component

Returns:

Unique ID of the component.

Throws:

java.rmi.RemoteException