pt.ua.dicoogle.plugins

Class PluginController

java.lang.Object

pt.ua.dicoogle.plugins.PluginController

public class PluginController
extends java.lang.Object

PluginController is the core of the Plugins architecture.

It loads the plugins, takes care of the list of active plugins and control the tasks that are exchanged between plugins and core plugins

Constructor Summary

Constructors

Constructor and Description
PluginController(java.io.File pathToPluginDirectory)

Method Summary

Modifier and Type	Method and Description
void	addTask(TaskRequest task)
void	doRemove(java.net.URI uri, StorageInterface si)
java.util.HashMap<java.lang.String,java.lang.String>	getAdvancedSettingsHelp(java.lang.String pluginName)
IndexerInterface	getIndexerByName(java.lang.String name, boolean onlyEnabled)
java.util.Collection<IndexerInterface>	getIndexingPlugins(boolean onlyEnabled)
static PluginController	getInstance()
java.util.List<javax.swing.JMenuItem>	getMenuItems() Deprecated.
java.util.Collection<QueryInterface>	getQueryPlugins(boolean onlyEnabled)
QueryInterface	getQueryProviderByName(java.lang.String name, boolean onlyEnabled)
java.util.List<java.lang.String>	getQueryProvidersName(boolean enabled)
java.util.List<javax.swing.JMenuItem>	getRightButtonItems() Deprecated.
StorageInterface	getStorageForSchema(java.lang.String scheme) Retrieve a storage interface capable of handling files with the given scheme.
StorageInterface	getStorageForSchema(java.net.URI location) Retrieve a storage interface capable of handling files on a given location.
java.util.Collection<StorageInterface>	getStoragePlugins(boolean onlyEnabled)
java.util.List<javax.swing.JPanel>	getTabItems() Deprecated.
java.lang.String	getWebUIModuleJS(java.lang.String name) Retrieve the web UI plugin module code.
java.lang.String	getWebUIPackageJSON(java.lang.String name) Retrieve the web UI plugin descriptor package.json.
WebUIPlugin	getWebUIPlugin(java.lang.String name) Retrieve the web UI plugin descriptor of the plugin with the given name.
java.util.Collection<WebUIPlugin>	getWebUIPlugins(java.lang.String... ids) Retrieve all web UI plugin descriptors for the given slot id.
boolean	hasAdvancedSettings(java.lang.String pluginName) TODO: REVIEW! BELOW Checks if the plugin exists and has advanced/internal settings.
java.util.List<Task<Report>>	index(java.lang.String pluginName, java.net.URI path)
java.util.List<Task<Report>>	index(java.net.URI path)
java.util.List<Report>	indexBlocking(java.net.URI path)
JointQueryTask	query(JointQueryTask holder, java.util.List<java.lang.String> querySources, java.lang.String query, java.lang.Object... parameters)
Task<java.lang.Iterable<SearchResult>>	query(java.lang.String querySource, java.lang.String query, java.lang.Object... parameters)
JointQueryTask	queryAll(JointQueryTask holder, java.lang.String query, java.lang.Object... parameters)
void	remove(java.net.URI uri)
java.lang.Iterable<StorageInputStream>	resolveURI(java.net.URI location, java.lang.Object... args) Resolve a URI to a DicomInputStream
void	shutdown() Stops the plugins and saves the settings
void	startPlugin(java.lang.String pluginName)
void	stopPlugin(java.lang.String pluginName) stops a pluginset.
void	unindex(java.net.URI path)
void	unindex(java.net.URI path, java.util.Collection<java.lang.String> indexProviders) Issue the removal of indexed entries in a path from the given indexers.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginController

public PluginController(java.io.File pathToPluginDirectory)

Method Detail

getInstance

public static PluginController getInstance()

shutdown

public void shutdown()
              throws java.io.IOException

Stops the plugins and saves the settings

Throws:

java.io.IOException

stopPlugin

public void stopPlugin(java.lang.String pluginName)

stops a pluginset. this could be more efficient, however this is hardly a bottleneck TODO: needs more granularity, we should be able to stop only the indexers or the queryers

Parameters:

pluginName -

startPlugin

public void startPlugin(java.lang.String pluginName)

getIndexingPlugins

public java.util.Collection<IndexerInterface> getIndexingPlugins(boolean onlyEnabled)

getStoragePlugins

public java.util.Collection<StorageInterface> getStoragePlugins(boolean onlyEnabled)

resolveURI

public java.lang.Iterable<StorageInputStream> resolveURI(java.net.URI location,
                                                         java.lang.Object... args)

Resolve a URI to a DicomInputStream

Parameters:

location -

args -

Returns:

getStorageForSchema

public StorageInterface getStorageForSchema(java.net.URI location)

Retrieve a storage interface capable of handling files on a given location. TODO: this can be heavily improved if we keep a map of scheme->indexer However we are not supposed to call this every other cycle. TODO: we should return a proxy storage that always returns error

Parameters:

location - a URI of the location, only the scheme matters

Returns:

a storage interface capable of handling the location, null if no suitable plugin is found

getStorageForSchema

public StorageInterface getStorageForSchema(java.lang.String scheme)

Retrieve a storage interface capable of handling files with the given scheme. TODO: this can be heavily improved if we keep a map of scheme->indexer However we are not supposed to call this every other cycle. TODO: we should return a proxy storage that always returns error

Parameters:

scheme - a URI of the location, only the scheme matters

Returns:

a storage interface capable of handling the location, null if no suitable plugin is found

getQueryPlugins

public java.util.Collection<QueryInterface> getQueryPlugins(boolean onlyEnabled)

addTask

public void addTask(TaskRequest task)

getQueryProvidersName

public java.util.List<java.lang.String> getQueryProvidersName(boolean enabled)

getQueryProviderByName

public QueryInterface getQueryProviderByName(java.lang.String name,
                                             boolean onlyEnabled)

getIndexerByName

public IndexerInterface getIndexerByName(java.lang.String name,
                                         boolean onlyEnabled)

queryAll

public JointQueryTask queryAll(JointQueryTask holder,
                               java.lang.String query,
                               java.lang.Object... parameters)

query

public Task<java.lang.Iterable<SearchResult>> query(java.lang.String querySource,
                                                    java.lang.String query,
                                                    java.lang.Object... parameters)

query

public JointQueryTask query(JointQueryTask holder,
                            java.util.List<java.lang.String> querySources,
                            java.lang.String query,
                            java.lang.Object... parameters)

index

public java.util.List<Task<Report>> index(java.net.URI path)

index

public java.util.List<Task<Report>> index(java.lang.String pluginName,
                                          java.net.URI path)

unindex

public void unindex(java.net.URI path)

unindex

public void unindex(java.net.URI path,
                    java.util.Collection<java.lang.String> indexProviders)

Issue the removal of indexed entries in a path from the given indexers.

Parameters:

path - the URI of the directory or file to unindex

indexProviders - a collection of providers

remove

public void remove(java.net.URI uri)

doRemove

public void doRemove(java.net.URI uri,
                     StorageInterface si)

indexBlocking

public java.util.List<Report> indexBlocking(java.net.URI path)

getRightButtonItems

@Deprecated
public java.util.List<javax.swing.JMenuItem> getRightButtonItems()

Deprecated.

getTabItems

@Deprecated
public java.util.List<javax.swing.JPanel> getTabItems()

Deprecated.

getMenuItems

@Deprecated
public java.util.List<javax.swing.JMenuItem> getMenuItems()

Deprecated.

getWebUIPlugins

public java.util.Collection<WebUIPlugin> getWebUIPlugins(java.lang.String... ids)

Retrieve all web UI plugin descriptors for the given slot id.

Parameters:

ids - the slot id's for the plugin ("query", "result", "menu", ...), empty or null for any slot

Returns:

a collection of web UI plugins.

getWebUIPlugin

public WebUIPlugin getWebUIPlugin(java.lang.String name)

Retrieve the web UI plugin descriptor of the plugin with the given name.

Parameters:

name - the unique name of the plugin

Returns:

a web UI plugin descriptor object, or null if no such plugin exists or is inactive

getWebUIPackageJSON

public java.lang.String getWebUIPackageJSON(java.lang.String name)

Retrieve the web UI plugin descriptor package.json.

Parameters:

name - the unique name of the plugin

Returns:

the full contents of the package.json, null if the plugin is not available

getWebUIModuleJS

public java.lang.String getWebUIModuleJS(java.lang.String name)

Retrieve the web UI plugin module code.

Parameters:

name - the unique name of the plugin

Returns:

the full contents of the module file, null if the plugin is not available

hasAdvancedSettings

public boolean hasAdvancedSettings(java.lang.String pluginName)

TODO: REVIEW! BELOW Checks if the plugin exists and has advanced/internal settings.

Parameters:

pluginName - the name of the plugin.

Returns:

true if the plugin exists and has at least one advance/internal settings, false otherwise.

getAdvancedSettingsHelp

public java.util.HashMap<java.lang.String,java.lang.String> getAdvancedSettingsHelp(java.lang.String pluginName)