Package de.unirostock.sems.morre.client

Interface Morre

All Superinterfaces:

Serializable

All Known Implementing Classes:

HttpMorreClient

public interface Morre
extends Serializable

Interface for performing search queries to the MORRE database API

Author:

Martin Peters

Method Summary

Modifier and Type	Method	Description
List<ModelResult>	aggregatedModelQuery(String query, String aggregationType, String rankerWeights)	Returns the available features for a given query type.
List<AnnotationResult>	doAnnotationQuery(String query)	Searches for Annotations on the basis of the given query String.
List<ModelResult>	doModelQuery(String queryType, FeatureSet features)	Performs a more complex query of the given type The available features can be retrieved by getQueryFeatures.
List<PersonResult>	doPersonQuery(FeatureSet features)	Searches for a Person on the basis of the given features The available features can be retrieved by getQueryFeatures.
List<PublicationResult>	doPublicationQuery(FeatureSet features)	Searches for a Publication on the basis of the given features The available features can be retrieved by getQueryFeatures.
List<ModelResult>	doSimpleAggregatedModelQuery(String queryType, String keyword, String aggregationType, String rankersWeights)	Searches for a Person on the basis of the given features The available features can be retrieved by getQueryFeatures.
List<ModelResult>	doSimpleModelQuery(String queryType, String keyword)	Performs a simple query with only one keyword field for the given queryType Note: Only some queryTypes are supporting this method!
List<String>	getQueryFeatures(String queryType)	Returns the available features for a given query type and an aggregation type.
List<ModelResult>	modelQuery(String query)	Searches for a model on the basis of a simple query.

Method Detail

modelQuery

List<ModelResult> modelQuery(String query)
                      throws MorreException,
                             MorreClientException,
                             MorreCommunicationException

Searches for a model on the basis of a simple query.

Parameters:

query - String

Returns:

List of ModelResults

Throws:

MorreException - the morre exception

MorreClientException - the morre client exception

MorreCommunicationException - the morre communication exception

aggregatedModelQuery

List<ModelResult> aggregatedModelQuery(String query,
                                       String aggregationType,
                                       String rankerWeights)
                                throws MorreException,
                                       MorreClientException,
                                       MorreCommunicationException

Returns the available features for a given query type.

Parameters:

query - the query

aggregationType - the aggregation type

rankerWeights - the ranker weights

Returns:

List of Strings with all available feature keywords

Throws:

MorreException - the morre exception

MorreClientException - the morre client exception

MorreCommunicationException - the morre communication exception

getQueryFeatures

List<String> getQueryFeatures(String queryType)
                       throws MorreException,
                              MorreClientException,
                              MorreCommunicationException

Returns the available features for a given query type and an aggregation type.

Parameters:

queryType - the query type

Returns:

List of Strings with all available feature keywords

Throws:

MorreException - the morre exception

MorreClientException - the morre client exception

MorreCommunicationException - the morre communication exception

doModelQuery

List<ModelResult> doModelQuery(String queryType,
                               FeatureSet features)
                        throws MorreException,
                               MorreClientException,
                               MorreCommunicationException

Performs a more complex query of the given type The available features can be retrieved by getQueryFeatures.

Parameters:

queryType - the query type

features - the features

Returns:

List of ModelResults

Throws:

MorreException - the morre exception

MorreClientException - the morre client exception

MorreCommunicationException - the morre communication exception

doSimpleModelQuery

List<ModelResult> doSimpleModelQuery(String queryType,
                                     String keyword)
                              throws MorreException,
                                     MorreClientException,
                                     MorreCommunicationException

Performs a simple query with only one keyword field for the given queryType Note: Only some queryTypes are supporting this method!

Parameters:

queryType - the query type

keyword - String

Returns:

List of ModelResults

Throws:

MorreException - the morre exception

MorreClientException - the morre client exception

MorreCommunicationException - the morre communication exception

doSimpleAggregatedModelQuery

List<ModelResult> doSimpleAggregatedModelQuery(String queryType,
                                               String keyword,
                                               String aggregationType,
                                               String rankersWeights)
                                        throws MorreException,
                                               MorreClientException,
                                               MorreCommunicationException

Searches for a Person on the basis of the given features The available features can be retrieved by getQueryFeatures.

Parameters:

queryType - the query type

keyword - the keyword

aggregationType - the aggregation type

rankersWeights - the rankers weights

Returns:

List of PersonResults

Throws:

MorreException - the morre exception

MorreClientException - the morre client exception

MorreCommunicationException - the morre communication exception

doPersonQuery

List<PersonResult> doPersonQuery(FeatureSet features)
                          throws MorreException,
                                 MorreClientException,
                                 MorreCommunicationException

Searches for a Person on the basis of the given features The available features can be retrieved by getQueryFeatures.

Parameters:

features - the features

Returns:

List of PersonResults

Throws:

MorreException - the morre exception

MorreClientException - the morre client exception

MorreCommunicationException - the morre communication exception

doPublicationQuery

List<PublicationResult> doPublicationQuery(FeatureSet features)
                                    throws MorreException,
                                           MorreClientException,
                                           MorreCommunicationException

Searches for a Publication on the basis of the given features The available features can be retrieved by getQueryFeatures.

Parameters:

features - the features

Returns:

List of PublicationResults

Throws:

MorreException - the morre exception

MorreClientException - the morre client exception

MorreCommunicationException - the morre communication exception

doAnnotationQuery

List<AnnotationResult> doAnnotationQuery(String query)
                                  throws MorreException,
                                         MorreClientException,
                                         MorreCommunicationException

Searches for Annotations on the basis of the given query String.

Parameters:

query - String

Returns:

List of AnnotationResults

Throws:

MorreException - the morre exception

MorreClientException - the morre client exception

MorreCommunicationException - the morre communication exception