uk.ac.ebi.arrayexpress2.magetab.handler

Class HandlerLoader

java.lang.Object

uk.ac.ebi.arrayexpress2.magetab.handler.HandlerLoader

public class HandlerLoader
extends Object

Loads Handler implementations available using service provider discovery (SPI annotations). This class can probe the classpath for available ReadHandlers, ConversionHandlers and ValidateHandlers before load new instances of each.

Convenience methods are supplied to obtain handlers for given IDF, SDRF and ADF headers.

Author:

Tony Burdett

Constructor Summary

Constructors

Constructor and Description
HandlerLoader()

Method Summary

Methods

Modifier and Type	Method and Description
Collection<ADFGraphReadHandler>	getADFGraphReadHandlers(String[] header) Lookup ADF reading handlers that can read a particular header.
Collection<ADFHeaderReadHandler>	getADFHeaderReadHandlers(String header) Lookup ADF reading handlers that can read a particular header.
Collection<ConversionHandler<?,?>>	getConversionHandlers() Gets the collection of all available ConversionHandlers.
static HandlerLoader	getHandlerLoader()
Collection<IDFReadHandler>	getIDFReadHandlers(String header) Lookup IDF reading handlers that can read a particular header.
protected org.slf4j.Logger	getLog()
Collection<ReadHandler<?,?,?>>	getReadHandlers() Gets the collection of all available ReadHandlers.
<T extends ReadHandler,S> Collection<T>	getReadHandlersOfType(Class<T> superclass, S header) Generic method for looking up ReadHandlers that extend the given superclass and can read from the given header.
Collection<SDRFReadHandler>	getSDRFReadHandlers(String[] header) Lookup SDRF reading handlers that can read a particular header.
Collection<ValidateHandler<?>>	getValidateHandlers() Gets the collection of all available ValidateHandlers.
void	loadHandlers() Loads all handlers available.
void	reloadHandlers() Clears any currently loaded handlers and reloads handlers available on the classpath.

Methods inherited from class java.lang.Object

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

Constructor Detail

HandlerLoader

public HandlerLoader()

Method Detail

getHandlerLoader

public static HandlerLoader getHandlerLoader()

getLog

protected org.slf4j.Logger getLog()

loadHandlers

public void loadHandlers()

Loads all handlers available. This looks up configured handlers using an SPI implementation. Handlers can be enabled for discovery by implementing one of the Service Provider Interfaces ReadHandler, ConversionHandler or ValidateHandler and adding a ServiceProvider annotation to the implementation.

reloadHandlers

public void reloadHandlers()

Clears any currently loaded handlers and reloads handlers available on the classpath. Use this for dynamic discovery of handlers, but you must take control of loading new handlers to the current classloader.

getReadHandlers

public Collection<ReadHandler<?,?,?>> getReadHandlers()

Gets the collection of all available ReadHandlers.

Returns:

all available read handlers

getConversionHandlers

public Collection<ConversionHandler<?,?>> getConversionHandlers()

Gets the collection of all available ConversionHandlers.

Returns:

all available convert handlers

getValidateHandlers

public Collection<ValidateHandler<?>> getValidateHandlers()

Gets the collection of all available ValidateHandlers.

Returns:

all available validate handlers

getIDFReadHandlers

public Collection<IDFReadHandler> getIDFReadHandlers(String header)

Lookup IDF reading handlers that can read a particular header. The collection will contain one handler instance per class that is capable of reading data from the part of the IDF with the given header

Parameters:

header - the header to read

Returns:

the collection of possible read handler instance that can read this header

getSDRFReadHandlers

public Collection<SDRFReadHandler> getSDRFReadHandlers(String[] header)

Lookup SDRF reading handlers that can read a particular header. The collection will contain one handler instance per class that is capable of reading data from the part of the SDRF with the given header

Parameters:

header - the header to read

Returns:

the collection of possible read handler instance that can read this header

getADFHeaderReadHandlers

public Collection<ADFHeaderReadHandler> getADFHeaderReadHandlers(String header)

Lookup ADF reading handlers that can read a particular header. The collection will contain one handler instance per class that is capable of reading data from the header part of the ADF with the given header

Parameters:

header - the header to read

Returns:

the collection of possible read handler instance that can read this header

getADFGraphReadHandlers

public Collection<ADFGraphReadHandler> getADFGraphReadHandlers(String[] header)

Lookup ADF reading handlers that can read a particular header. The collection will contain one handler instance per class that is capable of reading data from the graph part of the ADF with the given header

Parameters:

header - the header to read

Returns:

the collection of possible read handler instance that can read this header

getReadHandlersOfType

public <T extends ReadHandler,S> Collection<T> getReadHandlersOfType(Class<T> superclass,
                                                            S header)

Generic method for looking up ReadHandlers that extend the given superclass and can read from the given header. The collection will contain one handler instance per class that is capable of reading data from the part of the document with the given header.

Type Parameters:

T - the generic type of the handler class

S - the header type

Parameters:

superclass - the superclass of the handler that you wish to filter by

header - the head to read

Returns:

the collection of possible read handler instances that can read this header