Package de.unirostock.sems.morre.client.impl

Class HttpMorreClient

java.lang.Object

de.unirostock.sems.morre.client.impl.HttpMorreClient

All Implemented Interfaces:

Morre, MorreCrawlerInterface, Serializable

public class HttpMorreClient
extends Object
implements Morre, MorreCrawlerInterface, Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
HttpMorreClient(String morreUrl)

Method Summary

Modifier and Type	Method	Description
boolean	addModel(CrawledModel model)	Adds a model to the database.
List<ModelResult>	aggregatedModelQuery(String query, String aggregationType, String rankersWeights)	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!
CrawledModel	getLatestModelVersion(String fileId)	Returns the latest version of a model as dataholder object.
List<String>	getModelHistory(String fileId)	Returns all available versions of this model as String List.
CrawledModel	getModelVersion(String fileId, String versionId)	Returns one specific version of a model as dataholder object.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpMorreClient

public HttpMorreClient(String morreUrl)
                throws MalformedURLException

Throws:

MalformedURLException

Method Detail

modelQuery

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

Description copied from interface: Morre

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

Specified by:

modelQuery in interface Morre

Parameters:

query - String

Returns:

List of ModelResults

Throws:

MorreClientException - the morre client exception

MorreCommunicationException - the morre communication exception

MorreException - the morre exception

aggregatedModelQuery

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

Description copied from interface: Morre

Returns the available features for a given query type.

Specified by:

aggregatedModelQuery in interface Morre

Parameters:

query - the query

aggregationType - the aggregation type

rankersWeights - the ranker weights

Returns:

List of Strings with all available feature keywords

Throws:

MorreClientException - the morre client exception

MorreCommunicationException - the morre communication exception

MorreException - the morre exception

getQueryFeatures

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

Description copied from interface: Morre

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

Specified by:

getQueryFeatures in interface Morre

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

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

Description copied from interface: Morre

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

Specified by:

doModelQuery in interface Morre

Parameters:

queryType - the query type

features - the features

Returns:

List of ModelResults

Throws:

MorreClientException - the morre client exception

MorreCommunicationException - the morre communication exception

MorreException - the morre exception

doSimpleModelQuery

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

Description copied from interface: Morre

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

Specified by:

doSimpleModelQuery in interface Morre

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

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

Description copied from interface: Morre

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

Specified by:

doSimpleAggregatedModelQuery in interface Morre

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

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

Description copied from interface: Morre

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

Specified by:

doPersonQuery in interface Morre

Parameters:

features - the features

Returns:

List of PersonResults

Throws:

MorreClientException - the morre client exception

MorreCommunicationException - the morre communication exception

MorreException - the morre exception

doAnnotationQuery

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

Description copied from interface: Morre

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

Specified by:

doAnnotationQuery in interface Morre

Parameters:

query - String

Returns:

List of AnnotationResults

Throws:

MorreClientException - the morre client exception

MorreCommunicationException - the morre communication exception

MorreException - the morre exception

doPublicationQuery

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

Description copied from interface: Morre

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

Specified by:

doPublicationQuery in interface Morre

Parameters:

features - the features

Returns:

List of PublicationResults

Throws:

MorreException - the morre exception

MorreClientException - the morre client exception

MorreCommunicationException - the morre communication exception

getModelHistory

public List<String> getModelHistory(String fileId)
                             throws MorreClientException,
                                    MorreCommunicationException,
                                    MorreException

Description copied from interface: MorreCrawlerInterface

Returns all available versions of this model as String List.

Specified by:

getModelHistory in interface MorreCrawlerInterface

Parameters:

fileId - the file id

Returns:

the model history

Throws:

MorreClientException - the morre client exception

MorreCommunicationException - the morre communication exception

MorreException - the morre exception

getModelVersion

public CrawledModel getModelVersion(String fileId,
                                    String versionId)
                             throws MorreClientException,
                                    MorreCommunicationException,
                                    MorreException

Description copied from interface: MorreCrawlerInterface

Returns one specific version of a model as dataholder object.

Specified by:

getModelVersion in interface MorreCrawlerInterface

Parameters:

fileId - the file id

versionId - the version id

Returns:

the model version

Throws:

MorreClientException - the morre client exception

MorreCommunicationException - the morre communication exception

MorreException - the morre exception

getLatestModelVersion

public CrawledModel getLatestModelVersion(String fileId)
                                   throws MorreClientException,
                                          MorreCommunicationException,
                                          MorreException

Description copied from interface: MorreCrawlerInterface

Returns the latest version of a model as dataholder object.

Specified by:

getLatestModelVersion in interface MorreCrawlerInterface

Parameters:

fileId - the file id

Returns:

the latest model version

Throws:

MorreClientException - the morre client exception

MorreCommunicationException - the morre communication exception

MorreException - the morre exception

addModel

public boolean addModel(CrawledModel model)
                 throws MorreClientException,
                        MorreCommunicationException,
                        MorreException

Description copied from interface: MorreCrawlerInterface

Adds a model to the database.

Specified by:

addModel in interface MorreCrawlerInterface

Parameters:

model - the model

Returns:

true, if adds the model

Throws:

MorreClientException - the morre client exception

MorreCommunicationException - the morre communication exception

MorreException - the morre exception