service.tut.pori.contentanalysis

Class ContentAnalysisService

java.lang.Object

service.tut.pori.contentanalysis.ContentAnalysisService

@HTTPService(name="ca")
public class ContentAnalysisService
extends java.lang.Object

This service enables content analysis and provides search features.

See Also:

ClientService, ServerService

Constructor Summary

Constructors

Constructor and Description
ContentAnalysisService()

Method Summary

Modifier and Type	Method and Description
Response	deletePhotos(AuthenticationParameter authenticatedUser, StringParameter guid)
Response	getPhotos(AuthenticationParameter authenticatedUser, StringParameter guid, DataGroups dataGroups, Limits limits, IntegerParameter serviceIds, LongParameter userIds)
Response	queryTaskDetails(IntegerParameter backendId, LongParameter taskId, DataGroups dataGroups, Limits limits)
RedirectResponse	r(AuthenticationParameter authenticatedUser, IntegerParameter serviceId, StringParameter guid)
Response	retrieveMediaObjects(AuthenticationParameter authenticatedUser, DataGroups dataGroups, Limits limits, IntegerParameter serviceIds, StringParameter mediaObjectIds)
Response	searchSimilarByContent(AuthenticationParameter authenticatedUser, StringParameter analysisType, StringParameter url, DataGroups dataGroups, Limits limits, IntegerParameter serviceIds, LongParameter userIdFilters)
Response	searchSimilarById(AuthenticationParameter authenticatedUser, StringParameter guid, StringParameter analysisType, DataGroups dataGroups, Limits limits, IntegerParameter serviceIds, LongParameter userIdFilters) Returns photos that are similar with the photo associated with the given id.
Response	searchSimilarByKeyword(AuthenticationParameter authenticatedUser, StringParameter keywords, DataGroups dataGroups, Limits limits, IntegerParameter serviceIds, LongParameter userIdFilters) Returns photos that are associated with the given keywords.
void	similarityFeedback(AuthenticationParameter authenticatedUser, InputStreamParameter xml)
Response	similarPhotosByObject(AuthenticationParameter authenticatedUser, DataGroups dataGroups, Limits limits, IntegerParameter serviceIds, LongParameter userIdFilters, InputStreamParameter xml)
void	taskFinished(InputStreamParameter xml)
void	updatePhotos(AuthenticationParameter authenticatedUser, InputStreamParameter xml)

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentAnalysisService

public ContentAnalysisService()

Method Detail

searchSimilarByKeyword

@HTTPServiceMethod(name="similarPhotosByKeyword",
                   acceptedMethods="GET")
public Response searchSimilarByKeyword(@HTTPAuthenticationParameter(required=false)
                                                                                                                                     AuthenticationParameter authenticatedUser,
                                                                                                                                     @HTTPMethodParameter(name="keywords")
                                                                                                                                     StringParameter keywords,
                                                                                                                                     @HTTPMethodParameter(name="data_groups",required=false)
                                                                                                                                     DataGroups dataGroups,
                                                                                                                                     @HTTPMethodParameter(name="limits",required=false)
                                                                                                                                     Limits limits,
                                                                                                                                     @HTTPMethodParameter(name="service_id",required=false)
                                                                                                                                     IntegerParameter serviceIds,
                                                                                                                                     @HTTPMethodParameter(name="user_id",required=false)
                                                                                                                                     LongParameter userIdFilters)

Returns photos that are associated with the given keywords.

Parameters:

authenticatedUser -

keywords -

dataGroups -

limits -

serviceIds -

userIdFilters -

Returns:

response

See Also:

ClientService.searchSimilarByKeyword(AuthenticationParameter, StringParameter, DataGroups, Limits, IntegerParameter, LongParameter)

updatePhotos

@HTTPServiceMethod(name="updatePhotos",
                   acceptedMethods="POST")
public void updatePhotos(@HTTPAuthenticationParameter
                                                                                                              AuthenticationParameter authenticatedUser,
                                                                                                              @HTTPMethodParameter(name="body",bodyParameter=true)
                                                                                                              InputStreamParameter xml)

Parameters:

authenticatedUser -

xml -

See Also:

ClientService.updatePhotos(AuthenticationParameter, InputStreamParameter)

retrieveMediaObjects

@HTTPServiceMethod(name="getObjects",
                   acceptedMethods="GET")
public Response retrieveMediaObjects(@HTTPAuthenticationParameter(required=false)
                                                                                                                       AuthenticationParameter authenticatedUser,
                                                                                                                       @HTTPMethodParameter(name="data_groups",required=false)
                                                                                                                       DataGroups dataGroups,
                                                                                                                       @HTTPMethodParameter(name="limits",required=false)
                                                                                                                       Limits limits,
                                                                                                                       @HTTPMethodParameter(name="service_id",required=false)
                                                                                                                       IntegerParameter serviceIds,
                                                                                                                       @HTTPMethodParameter(name="media_object_id",required=false)
                                                                                                                       StringParameter mediaObjectIds)

Parameters:

authenticatedUser -

dataGroups -

limits -

serviceIds -

mediaObjectIds -

Returns:

response

See Also:

ClientService.retrieveMediaObjects(AuthenticationParameter, DataGroups, Limits, IntegerParameter, StringParameter)

similarityFeedback

@HTTPServiceMethod(name="similarityFeedback",
                   acceptedMethods="POST")
public void similarityFeedback(@HTTPAuthenticationParameter
                                                                                                                          AuthenticationParameter authenticatedUser,
                                                                                                                          @HTTPMethodParameter(name="body",bodyParameter=true)
                                                                                                                          InputStreamParameter xml)

Parameters:

authenticatedUser -

xml -

See Also:

ClientService.similarityFeedback(AuthenticationParameter, InputStreamParameter)

searchSimilarById

@HTTPServiceMethod(name="similarPhotosById",
                   acceptedMethods="GET")
public Response searchSimilarById(@HTTPAuthenticationParameter(required=false)
                                                                                                                           AuthenticationParameter authenticatedUser,
                                                                                                                           @HTTPMethodParameter(name="uid")
                                                                                                                           StringParameter guid,
                                                                                                                           @HTTPMethodParameter(name="analysis_type",required=false)
                                                                                                                           StringParameter analysisType,
                                                                                                                           @HTTPMethodParameter(name="data_groups",required=false)
                                                                                                                           DataGroups dataGroups,
                                                                                                                           @HTTPMethodParameter(name="limits",required=false)
                                                                                                                           Limits limits,
                                                                                                                           @HTTPMethodParameter(name="service_id",required=false)
                                                                                                                           IntegerParameter serviceIds,
                                                                                                                           @HTTPMethodParameter(name="user_id",required=false)
                                                                                                                           LongParameter userIdFilters)

Returns photos that are similar with the photo associated with the given id.

Parameters:

authenticatedUser -

analysisType -

guid -

dataGroups -

limits -

serviceIds -

userIdFilters -

Returns:

response

See Also:

ClientService.searchSimilarById(AuthenticationParameter, StringParameter, StringParameter, DataGroups, Limits, IntegerParameter, LongParameter)

searchSimilarByContent

@HTTPServiceMethod(name="similarPhotosByContent",
                   acceptedMethods="GET")
public Response searchSimilarByContent(@HTTPAuthenticationParameter(required=false)
                                                                                                                                     AuthenticationParameter authenticatedUser,
                                                                                                                                     @HTTPMethodParameter(name="analysis_type",required=false)
                                                                                                                                     StringParameter analysisType,
                                                                                                                                     @HTTPMethodParameter(name="url")
                                                                                                                                     StringParameter url,
                                                                                                                                     @HTTPMethodParameter(name="data_groups",required=false)
                                                                                                                                     DataGroups dataGroups,
                                                                                                                                     @HTTPMethodParameter(name="limits",required=false)
                                                                                                                                     Limits limits,
                                                                                                                                     @HTTPMethodParameter(name="service_id",required=false)
                                                                                                                                     IntegerParameter serviceIds,
                                                                                                                                     @HTTPMethodParameter(name="user_id",required=false)
                                                                                                                                     LongParameter userIdFilters)

Parameters:

authenticatedUser -

analysisType -

url -

dataGroups -

limits -

serviceIds -

userIdFilters -

Returns:

response

See Also:

ClientService.searchSimilarByContent(AuthenticationParameter, StringParameter, StringParameter, DataGroups, Limits, IntegerParameter, LongParameter)

queryTaskDetails

@HTTPServiceMethod(name="queryTaskDetails",
                   acceptedMethods="GET")
public Response queryTaskDetails(@HTTPMethodParameter(name="backend_id")
                                                                                                                         IntegerParameter backendId,
                                                                                                                         @HTTPMethodParameter(name="task_id")
                                                                                                                         LongParameter taskId,
                                                                                                                         @HTTPMethodParameter(name="data_groups",required=false)
                                                                                                                         DataGroups dataGroups,
                                                                                                                         @HTTPMethodParameter(name="limits",required=false)
                                                                                                                         Limits limits)

Parameters:

taskId -

backendId -

dataGroups -

limits -

Returns:

response

See Also:

ServerService.queryTaskDetails(IntegerParameter, LongParameter, DataGroups, Limits)

taskFinished

@HTTPServiceMethod(name="taskFinished",
                   acceptedMethods="POST")
public void taskFinished(@HTTPMethodParameter(name="body",bodyParameter=true)
                                                                                                              InputStreamParameter xml)

Parameters:

xml -

See Also:

ServerService.taskFinished(InputStreamParameter)

getPhotos

@HTTPServiceMethod(name="getPhotos",
                   acceptedMethods="GET")
public Response getPhotos(@HTTPAuthenticationParameter(required=false)
                                                                                                           AuthenticationParameter authenticatedUser,
                                                                                                           @HTTPMethodParameter(name="uid",required=false)
                                                                                                           StringParameter guid,
                                                                                                           @HTTPMethodParameter(name="data_groups",required=false)
                                                                                                           DataGroups dataGroups,
                                                                                                           @HTTPMethodParameter(name="limits",required=false)
                                                                                                           Limits limits,
                                                                                                           @HTTPMethodParameter(name="service_id",required=false)
                                                                                                           IntegerParameter serviceIds,
                                                                                                           @HTTPMethodParameter(name="user_id",required=false)
                                                                                                           LongParameter userIds)

Parameters:

authenticatedUser -

guid -

dataGroups -

limits -

serviceIds -

userIds -

Returns:

response

See Also:

ClientService.getPhotos(AuthenticationParameter, StringParameter, DataGroups, Limits, IntegerParameter, LongParameter)

similarPhotosByObject

@HTTPServiceMethod(name="similarPhotosByObject",
                   acceptedMethods="POST")
public Response similarPhotosByObject(@HTTPAuthenticationParameter(required=false)
                                                                                                                                    AuthenticationParameter authenticatedUser,
                                                                                                                                    @HTTPMethodParameter(name="data_groups",required=false)
                                                                                                                                    DataGroups dataGroups,
                                                                                                                                    @HTTPMethodParameter(name="limits",required=false)
                                                                                                                                    Limits limits,
                                                                                                                                    @HTTPMethodParameter(name="service_id",required=false)
                                                                                                                                    IntegerParameter serviceIds,
                                                                                                                                    @HTTPMethodParameter(name="user_id",required=false)
                                                                                                                                    LongParameter userIdFilters,
                                                                                                                                    @HTTPMethodParameter(name="body",bodyParameter=true)
                                                                                                                                    InputStreamParameter xml)

Parameters:

authenticatedUser -

dataGroups -

limits -

serviceIds -

userIdFilters -

xml -

Returns:

response

See Also:

ClientService.similarPhotosByObject(AuthenticationParameter, DataGroups, Limits, IntegerParameter, LongParameter, InputStreamParameter)

r

@HTTPServiceMethod(name="r",
                   acceptedMethods="GET")
public RedirectResponse r(@HTTPAuthenticationParameter(required=false)
                                                                                                   AuthenticationParameter authenticatedUser,
                                                                                                   @HTTPMethodParameter(name="service_id")
                                                                                                   IntegerParameter serviceId,
                                                                                                   @HTTPMethodParameter(name="uid")
                                                                                                   StringParameter guid)

Parameters:

authenticatedUser -

serviceId -

guid -

Returns:

response

See Also:

ClientService.r(AuthenticationParameter, IntegerParameter, StringParameter)

deletePhotos

@HTTPServiceMethod(name="deletePhotos",
                   acceptedMethods="DELETE")
public Response deletePhotos(@HTTPAuthenticationParameter
                                                                                                                    AuthenticationParameter authenticatedUser,
                                                                                                                    @HTTPMethodParameter(name="uid")
                                                                                                                    StringParameter guid)

Parameters:

authenticatedUser -

guid -

Returns:

response

See Also:

ClientService.deletePhotos(AuthenticationParameter, StringParameter)