omero.gateway.facility

Class Facility

java.lang.Object

omero.gateway.facility.Facility

Direct Known Subclasses:

AdminFacility, BrowseFacility, DataManagerFacility, MetadataFacility, RawDataFacility, ROIFacility, SearchFacility, TablesFacility, TransferFacility

public abstract class Facility
extends java.lang.Object

A Facility encapsulates a certain set of functionality for dealing with an OMERO server

Since:

5.1

Author:

Dominik Lindner d.lindner@dundee.ac.uk

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Adds a PropertyChangeListener
static void	clear() Clears the Facility object cache
void	firePropertyChanged(java.beans.PropertyChangeEvent event) Fires a PropertyChangeEvent
void	firePropertyChanged(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue) Fires a PropertyChangeEvent
static <T extends Facility> T	getFacility(java.lang.Class<T> type, Gateway gateway) Get a reference to a certain Facility
void	logDebug(java.lang.Object originator, java.lang.String msg, java.lang.Throwable t) Helper method to simplify logging
void	logError(java.lang.Object originator, java.lang.String msg, java.lang.Throwable t) Helper method to simplify logging
void	logInfo(java.lang.Object originator, java.lang.String msg, java.lang.Throwable t) Helper method to simplify logging
void	logWarn(java.lang.Object originator, java.lang.String msg, java.lang.Throwable t) Helper method to simplify logging
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Removes a PropertyChangeListener (Pass null to remove all PropertyChangeListeners)

Methods inherited from class java.lang.Object

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

Method Detail

getFacility

public static <T extends Facility> T getFacility(java.lang.Class<T> type,
                                                 Gateway gateway)
                                          throws java.util.concurrent.ExecutionException

Get a reference to a certain Facility

Parameters:

type - The type of the Facility

gateway - Reference to the Gateway

Returns:

See above

Throws:

java.util.concurrent.ExecutionException - If the Facility can't be retrieved or instantiated

clear

public static void clear()

Clears the Facility object cache

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Adds a PropertyChangeListener

Parameters:

listener - The listener

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Removes a PropertyChangeListener (Pass null to remove all PropertyChangeListeners)

Parameters:

listener - The listener

firePropertyChanged

public void firePropertyChanged(java.beans.PropertyChangeEvent event)

Fires a PropertyChangeEvent

Parameters:

event - The PropertyChangeEvent

firePropertyChanged

public void firePropertyChanged(java.lang.String propertyName,
                                java.lang.Object oldValue,
                                java.lang.Object newValue)

Fires a PropertyChangeEvent

Parameters:

propertyName - The property name

oldValue - The old value

newValue - The new value

logDebug

public void logDebug(java.lang.Object originator,
                     java.lang.String msg,
                     java.lang.Throwable t)

Helper method to simplify logging

Parameters:

originator - The source of the log message

msg - The message

t - The exception

logInfo

public void logInfo(java.lang.Object originator,
                    java.lang.String msg,
                    java.lang.Throwable t)

Helper method to simplify logging

Parameters:

originator - The source of the log message

msg - The message

t - The exception

logWarn

public void logWarn(java.lang.Object originator,
                    java.lang.String msg,
                    java.lang.Throwable t)

Helper method to simplify logging

Parameters:

originator - The source of the log message

msg - The message

t - The exception

logError

public void logError(java.lang.Object originator,
                     java.lang.String msg,
                     java.lang.Throwable t)

Helper method to simplify logging

Parameters:

originator - The source of the log message

msg - The message

t - The exception