pt.ua.dicoogle.sdk

Interface QueryInterface

All Superinterfaces:

DicooglePlugin

public interface QueryInterface
extends DicooglePlugin

Query Interface Plugin. Query plugins provide a means of handling queries and obtaining search results. They will usually rely on indices created by an indexer plugin.

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<SearchResult>	query(java.lang.String query, java.lang.Object... parameters) Performs a search on the database.

Methods inherited from interface pt.ua.dicoogle.sdk.DicooglePlugin

disable, enable, getName, getSettings, isEnabled, setSettings

Method Detail

query

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

Performs a search on the database. The consumer of the results would either request an iterator or use a for-each loop. The underlying iterator implementation can be redefined to wait for more results at the caller.

Parameters:

query - a string describing the query. The underlying plugin is currently free to follow any query format, but only those based on Lucene with work with the search user interface.

parameters - A variable list of parameters of the query. The plugin can use them to establish their own API's, which may require more complex data structures (e.g. images).

Returns:

the results of the query as a (possibly lazy) iterable