pt.ua.dicoogle.sdk.core

Interface DicooglePlatformInterface

All Known Implementing Classes:

DicooglePlatformProxy

public interface DicooglePlatformInterface

Interface for accessing external functionalities of the platform, including other plugins' interfaces.

For instance, if a graphical plugin needs to query, it will able to access query providers with this platform.

See Also:

QueryInterface, IndexerInterface, StorageInterface

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 scheme) 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 scheme) 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.

Method Detail

requestIndexPlugin

IndexerInterface requestIndexPlugin(java.lang.String name)

Gets an installed indexer plugin by name.

Parameters:

name - the name of the plugin

Returns:

the plugin that implements this interface

requestQueryPlugin

QueryInterface requestQueryPlugin(java.lang.String name)

Gets an installed query plugin by name.

Parameters:

name - the name of the plugin

Returns:

the plugin that implements this interface

getAllIndexPlugins

java.util.Collection<IndexerInterface> getAllIndexPlugins()

Obtains a collection of all active index plugins.

Returns:

an unmodifiable collection of active instances of IndexerInterface

getAllQueryPlugins

java.util.Collection<QueryInterface> getAllQueryPlugins()

Obtains a collection of all active query plugins.

Returns:

an unmodifiable collection of active instances of QueryInterface

getStoragePluginForSchema

StorageInterface getStoragePluginForSchema(java.lang.String scheme)

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

Parameters:

scheme - the storage scheme

Returns:

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

getStorageForSchema

StorageInterface getStorageForSchema(java.net.URI location)

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

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

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

Quickly obtains all storage elements at the given location.

Parameters:

location - the location to retrieve

args - a variable list of extra parameters for the retrieve

Returns:

an iterable of storage input streams

getStoragePlugins

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

Obtains all installed storage plugins.

Parameters:

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

Returns:

a collection of storage plugin interfaces

getStorageForSchema

StorageInterface getStorageForSchema(java.lang.String scheme)

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

Parameters:

scheme - the storage scheme

Returns:

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

getQueryPlugins

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

Obtains all installed query plugins.

Parameters:

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

Returns:

a collection of query plugin interfaces

getQueryProvidersName

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

Gets the names of all query providers.

Parameters:

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

Returns:

a collection of unique query provider names

getQueryProviderByName

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

Gets the query provider with the given name.

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

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

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

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

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. This operation is asynchronous and returns immediately.

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

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. This operation is asynchronous and returns immediately.

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

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

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

Parameters:

path - the path to index

Returns:

a list of asynchronous tasks, one for each provider

indexBlocking

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

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

Parameters:

path - the path to index

Returns:

a list of reports, one for each provider

getSettings

ServerSettingsReader getSettings()

Obtain access to the server's settings.

Returns:

an object for read-only access to the settings