pt.ua.dicoogle.sdk.utils.query

Class Query

java.lang.Object

pt.ua.dicoogle.sdk.task.JointQueryTask

pt.ua.dicoogle.sdk.utils.query.Query

public class Query
extends JointQueryTask

This class provides a very easy interface for querying in the Dicoogle. Especially in big data scenarios where users should be aware of memory restrictions. The usage of an iterative approach is enforced by the adapter. As such, query interface users are not tempted to use the tasks bulk get method. The query's business logic should be as much encompassed in the adapter as possible.

Constructor Summary

Constructors

Constructor and Description
Query(DicooglePlatformInterface controller, ForEachAdapter adapter) Initializes this helper class.

Method Summary

Modifier and Type	Method and Description
void	await() Awaits for the query to finish.
void	onCompletion()
void	onReceive(Task<java.lang.Iterable<SearchResult>> e)
void	query(java.util.List<java.lang.String> querySources, java.lang.String query, java.lang.Object... parameters) This method provides the same interface as the Dicoogle Platform Interface.
void	query(java.lang.String querySource, java.lang.String query, java.lang.Object... parameters) This method provides the same interface as the Dicoogle Platform Interface.
void	queryAll(java.lang.String query, java.lang.Object... parameters) This method provides the same interface as the Dicoogle Platform Interface.
void	setAdapter(ForEachAdapter adapter) Sets the for each adapter.
void	setController(DicooglePlatformInterface controller) Sets the Dicoogle Platform Controller.

Methods inherited from class pt.ua.dicoogle.sdk.task.JointQueryTask

addTask, cancel, get, getProgress, isCancelled, isDone

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

public Query(DicooglePlatformInterface controller,
             ForEachAdapter adapter)

Initializes this helper class.

Parameters:

controller - The dicoogle platform proxy.

adapter - The adapter holding the business logic of the query.

Method Detail

onCompletion

public void onCompletion()

Specified by:

onCompletion in class JointQueryTask

onReceive

public void onReceive(Task<java.lang.Iterable<SearchResult>> e)

Specified by:

onReceive in class JointQueryTask

await

public void await()

Awaits for the query to finish.

queryAll

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

This method provides the same interface as the Dicoogle Platform Interface. The await method is called after the query is performed. So this is a blocking method.

Parameters:

query - Query String

parameters - Parameters

See Also:

DicooglePlatformInterface

query

public void query(java.lang.String querySource,
                  java.lang.String query,
                  java.lang.Object... parameters)

This method provides the same interface as the Dicoogle Platform Interface. The await method is called after the query is performed. So this is a blocking method.

Parameters:

querySource - The query plugin's name

query - Query String

parameters - Parameters

See Also:

DicooglePlatformInterface

query

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

This method provides the same interface as the Dicoogle Platform Interface. The await method is called after the query is performed. So this is a blocking method.

Parameters:

querySources - A List holding the queries plugin's names that should handle the query.

query - Query String

parameters - Parameters

See Also:

DicooglePlatformInterface

setController

public void setController(DicooglePlatformInterface controller)

Sets the Dicoogle Platform Controller.

Parameters:

controller - The new controller.

setAdapter

public void setAdapter(ForEachAdapter adapter)

Sets the for each adapter.

Parameters:

adapter - The adapter.