pt.ua.dicoogle.plugins

Class DicooglePlatformProxy

java.lang.Object

pt.ua.dicoogle.plugins.DicooglePlatformProxy

All Implemented Interfaces:

DicooglePlatformInterface

public class DicooglePlatformProxy
extends java.lang.Object
implements DicooglePlatformInterface

A proxy to the implementations of Plugin Controller.

Constructor Summary

Constructors

Constructor and Description
DicooglePlatformProxy(PluginController pluginController)

Method Summary

Modifier and Type	Method and Description
java.util.Collection<IndexerInterface>	getAllIndexPlugins() Obtains a collection of all active index plugins.
java.util.Collection<QueryInterface>	getAllQueryPlugins() Obtains a collection of all active query plugins.
java.util.Collection<QueryInterface>	getQueryPlugins(boolean onlyEnabled) Obtains all installed query plugins.
QueryInterface	getQueryProviderByName(java.lang.String name, boolean onlyEnabled) Gets the query provider with the given name.
java.util.List<java.lang.String>	getQueryProvidersName(boolean enabled) Gets the names of all query providers.
ServerSettingsReader	getSettings() Obtain access to the server's settings.
StorageInterface	getStorageForSchema(java.lang.String schema) Obtains the storage interface for handling storage of the given scheme.
StorageInterface	getStorageForSchema(java.net.URI location) Obtains the storage interface for handling content in the given location.
StorageInterface	getStoragePluginForSchema(java.lang.String storage) Obtains the storage interface for handling storage of the given scheme.
java.util.Collection<StorageInterface>	getStoragePlugins(boolean onlyEnabled) Obtains all installed storage plugins.
java.util.List<Task<Report>>	index(java.net.URI path) Easily performs an indexation procedure over all active indexers.
java.util.List<Report>	indexBlocking(java.net.URI path) Easily performs an indexation procedure over all active indexers.
JointQueryTask	query(JointQueryTask holder, java.util.List<java.lang.String> querySources, java.lang.String query, java.lang.Object... parameters) Easily performs a query over multiple providers.
Task<java.lang.Iterable<SearchResult>>	query(java.lang.String querySource, java.lang.String query, java.lang.Object... parameters) Easily performs a query over a specific provider.
JointQueryTask	queryAll(JointQueryTask holder, java.lang.String query, java.lang.Object... parameters) Easily performs a query over all query providers.
IndexerInterface	requestIndexPlugin(java.lang.String name) Gets an installed indexer plugin by name.
QueryInterface	requestQueryPlugin(java.lang.String name) Gets an installed query plugin by name.
java.lang.Iterable<StorageInputStream>	resolveURI(java.net.URI location, java.lang.Object... args) Quickly obtains all storage elements at the given location.

Methods inherited from class java.lang.Object

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

Constructor Detail

DicooglePlatformProxy

public DicooglePlatformProxy(PluginController pluginController)

Method Detail

requestIndexPlugin

public IndexerInterface requestIndexPlugin(java.lang.String name)

Description copied from interface: DicooglePlatformInterface

Gets an installed indexer plugin by name.

Specified by:

requestIndexPlugin in interface DicooglePlatformInterface

Parameters:

name - the name of the plugin

Returns:

the plugin that implements this interface

requestQueryPlugin

public QueryInterface requestQueryPlugin(java.lang.String name)

Description copied from interface: DicooglePlatformInterface

Gets an installed query plugin by name.

Specified by:

requestQueryPlugin in interface DicooglePlatformInterface

Parameters:

name - the name of the plugin

Returns:

the plugin that implements this interface

getAllIndexPlugins

public java.util.Collection<IndexerInterface> getAllIndexPlugins()

Description copied from interface: DicooglePlatformInterface

Obtains a collection of all active index plugins.

Specified by:

getAllIndexPlugins in interface DicooglePlatformInterface

Returns:

an unmodifiable collection of active instances of IndexerInterface

getAllQueryPlugins

public java.util.Collection<QueryInterface> getAllQueryPlugins()

Description copied from interface: DicooglePlatformInterface

Obtains a collection of all active query plugins.

Specified by:

getAllQueryPlugins in interface DicooglePlatformInterface

Returns:

an unmodifiable collection of active instances of QueryInterface

getStoragePluginForSchema

public StorageInterface getStoragePluginForSchema(java.lang.String storage)

Description copied from interface: DicooglePlatformInterface

Obtains the storage interface for handling storage of the given scheme.

Specified by:

getStoragePluginForSchema in interface DicooglePlatformInterface

Parameters:

storage - the storage scheme

Returns:

the storage interface capable of handling that content, or null if no storage plugin installed can.

getStorageForSchema

public StorageInterface getStorageForSchema(java.net.URI location)

Description copied from interface: DicooglePlatformInterface

Obtains the storage interface for handling content in the given location.

Specified by:

getStorageForSchema in interface DicooglePlatformInterface

Parameters:

location - the storage location to check

Returns:

the storage interface capable of handling that content, or null if no storage plugin installed can

resolveURI

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

Description copied from interface: DicooglePlatformInterface

Quickly obtains all storage elements at the given location.

Specified by:

resolveURI in interface DicooglePlatformInterface

Parameters:

location - the location to retrieve

args - a variable list of extra parameters for the retrieve

Returns:

an iterable of storage input streams

getStoragePlugins

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

Description copied from interface: DicooglePlatformInterface

Obtains all installed storage plugins.

Specified by:

getStoragePlugins in interface DicooglePlatformInterface

Parameters:

onlyEnabled - whether only enabled plugins should be retrieved (all are retrieved if false)

Returns:

a collection of storage plugin interfaces

getStorageForSchema

public StorageInterface getStorageForSchema(java.lang.String schema)

Description copied from interface: DicooglePlatformInterface

Obtains the storage interface for handling storage of the given scheme. Same as DicooglePlatformInterface.getStoragePluginForSchema(java.lang.String).

Specified by:

getStorageForSchema in interface DicooglePlatformInterface

Parameters:

schema - the storage scheme

Returns:

the storage interface capable of handling that content, or null if no storage plugin installed can

getQueryPlugins

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

Description copied from interface: DicooglePlatformInterface

Obtains all installed query plugins.

Specified by:

getQueryPlugins in interface DicooglePlatformInterface

Parameters:

onlyEnabled - whether only enabled plugins should be retrieved (all are retrieved if false)

Returns:

a collection of query plugin interfaces

getQueryProvidersName

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

Description copied from interface: DicooglePlatformInterface

Gets the names of all query providers.

Specified by:

getQueryProvidersName in interface DicooglePlatformInterface

Parameters:

enabled - whether only enabled plugins should be retrieved (all are retrieved if false)

Returns:

a collection of unique query provider names

getQueryProviderByName

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

Description copied from interface: DicooglePlatformInterface

Gets the query provider with the given name.

Specified by:

getQueryProviderByName in interface DicooglePlatformInterface

Parameters:

name - the unique name of the provider

onlyEnabled - whether only enabled plugins should be retrieved (all are retrieved if false)

Returns:

a collection of unique query provider names

queryAll

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

Description copied from interface: DicooglePlatformInterface

Easily performs a query over all query providers. This operation is asynchronous and returns immediately.

Specified by:

queryAll in interface DicooglePlatformInterface

Parameters:

holder - a query task holder containing callback methods

query - a string describing the query

parameters - a variable list of extra parameters for the query

Returns:

a join query task

query

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

Description copied from interface: DicooglePlatformInterface

Easily performs a query over a specific provider. This operation is asynchronous and returns immediately.

Specified by:

query in interface DicooglePlatformInterface

Parameters:

querySource - the name of the query provider to issue

query - a string describing the query

parameters - a variable list of extra parameters for the query

Returns:

an asynchronous task containing the results

query

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

Description copied from interface: DicooglePlatformInterface

Easily performs a query over multiple providers. This operation is asynchronous and returns immediately.

Specified by:

query in interface DicooglePlatformInterface

Parameters:

holder - a query task holder containing callback methods

querySources - a list of names of query providers to issue

query - a string describing the query

parameters - a variable list of extra parameters for the query

Returns:

an asynchronous task containing the results

index

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

Description copied from interface: DicooglePlatformInterface

Easily performs an indexation procedure over all active indexers. This operation is asynchronous and returns immediately.

Specified by:

index in interface DicooglePlatformInterface

Parameters:

path - the path to index

Returns:

a list of asynchronous tasks, one for each provider

indexBlocking

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

Description copied from interface: DicooglePlatformInterface

Easily performs an indexation procedure over all active indexers. This operation is synchronous and will wait until all providers have finished indexing.

Specified by:

indexBlocking in interface DicooglePlatformInterface

Parameters:

path - the path to index

Returns:

a list of reports, one for each provider

getSettings

public ServerSettingsReader getSettings()

Description copied from interface: DicooglePlatformInterface

Obtain access to the server's settings.

Specified by:

getSettings in interface DicooglePlatformInterface

Returns:

an object for read-only access to the settings