org.youscope.plugin.microscopeaccess

Class MicroscopeConnectionFactoryImpl

java.lang.Object

org.youscope.plugin.microscopeaccess.MicroscopeConnectionFactoryImpl

All Implemented Interfaces:

MicroscopeConnectionFactory

public class MicroscopeConnectionFactoryImpl
extends java.lang.Object
implements MicroscopeConnectionFactory

Author:

langmo

Constructor Summary

Constructors

Constructor and Description
MicroscopeConnectionFactoryImpl()

Method Summary

Modifier and Type	Method and Description
MicroscopeInternal	createMicroscopeConnection(java.lang.String microscopeConnectionID, java.lang.String driverPath) Returns a new interface through which the drivers of the microscope can be accessed.
java.lang.String	getMicroscopeConnectionDescription(java.lang.String microscopeConnectionID) Returns a human readable description of the plug-in.
java.lang.String	getShortMicroscopeConnectionDescription(java.lang.String microscopeConnectionID) Returns a short (one line) human readable description of the plug-in.
java.lang.String[]	getSupportedMicroscopeConnectionIDs() Returns a list of all types of microscope connections the plug-in supports.
boolean	needsDriverPath(java.lang.String microscopeConnectionID) Returns true if the given connection type needs an URL to the folder where the microscope drivers are, false if such a folder is not needed.
boolean	supportsMicroscopeConnectionID(java.lang.String microscopeConnectionID) Returns true if the plug-in supports the given microscope connection type, false otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

MicroscopeConnectionFactoryImpl

public MicroscopeConnectionFactoryImpl()

Method Detail

createMicroscopeConnection

public MicroscopeInternal createMicroscopeConnection(java.lang.String microscopeConnectionID,
                                                     java.lang.String driverPath)
                                              throws MicroscopeConnectionException

Description copied from interface: MicroscopeConnectionFactory

Returns a new interface through which the drivers of the microscope can be accessed.

Specified by:

createMicroscopeConnection in interface MicroscopeConnectionFactory

Parameters:

microscopeConnectionID - The identifier of the microscope connection type.

driverPath - An URL to the local folder where the drivers are stored, or null if the respective connection type does not need such a folder.

Returns:

New microscope connection.

Throws:

MicroscopeConnectionException - Thrown if error in connecting to microManager occured.

supportsMicroscopeConnectionID

public boolean supportsMicroscopeConnectionID(java.lang.String microscopeConnectionID)

Description copied from interface: MicroscopeConnectionFactory

Returns true if the plug-in supports the given microscope connection type, false otherwise.

Specified by:

supportsMicroscopeConnectionID in interface MicroscopeConnectionFactory

Parameters:

microscopeConnectionID - The identifier of the microscope connection type.

Returns:

True if the plug-in supports the given connection type, false otherwise.

getSupportedMicroscopeConnectionIDs

public java.lang.String[] getSupportedMicroscopeConnectionIDs()

Description copied from interface: MicroscopeConnectionFactory

Returns a list of all types of microscope connections the plug-in supports.

Specified by:

getSupportedMicroscopeConnectionIDs in interface MicroscopeConnectionFactory

Returns:

List of supported microscope connection types.

needsDriverPath

public boolean needsDriverPath(java.lang.String microscopeConnectionID)

Description copied from interface: MicroscopeConnectionFactory

Returns true if the given connection type needs an URL to the folder where the microscope drivers are, false if such a folder is not needed.

Specified by:

needsDriverPath in interface MicroscopeConnectionFactory

Parameters:

microscopeConnectionID - The identifier of the microscope connection type.

Returns:

True if a folder location is needed.

getMicroscopeConnectionDescription

public java.lang.String getMicroscopeConnectionDescription(java.lang.String microscopeConnectionID)

Description copied from interface: MicroscopeConnectionFactory

Returns a human readable description of the plug-in. If a driver path is needed by this plug-in, instructions should be given to the user of how to precicely define this location.

Specified by:

getMicroscopeConnectionDescription in interface MicroscopeConnectionFactory

Parameters:

microscopeConnectionID - The identifier of the microscope connection type.

Returns:

Human readable description.

getShortMicroscopeConnectionDescription

public java.lang.String getShortMicroscopeConnectionDescription(java.lang.String microscopeConnectionID)

Description copied from interface: MicroscopeConnectionFactory

Returns a short (one line) human readable description of the plug-in.

Specified by:

getShortMicroscopeConnectionDescription in interface MicroscopeConnectionFactory

Parameters:

microscopeConnectionID - The identifier of the microscope connection type.

Returns:

Human readable description.