service.tut.pori.contentanalysis.reference

Class CAReferenceCore

java.lang.Object

service.tut.pori.contentanalysis.reference.CAReferenceCore

public final class CAReferenceCore
extends java.lang.Object

The reference implementations for Content Analysis Service.

Method Summary

Modifier and Type	Method and Description
static void	addTask(PhotoTaskDetails taskDetails) This performs a trivial check for the task contents, checking for the presence of a few key values.
static void	addTaskAsyncCallback(PhotoTaskDetails details, PhotoList photoList) Call asynchronously the callback given in the details, returning an example task response
static void	deletePhotos(UserIdentity authenticatedUser, java.util.List<java.lang.String> guids)
static void	executeAsyncCallback(org.apache.http.client.methods.HttpPost post)
static AnalysisBackend	generateAnalysisBackend()
static PhotoParameters	generateAnalysisParameters()
static BackendStatus	generateBackendStatus()
static BackendStatusList	generateBackendStatusList(Limits limits)
static PhotoFeedbackList	generateFeedbackList(Limits limits)
static MediaObject	generateMediaObject(DataGroups dataGroups)
static MediaObjectList	generateMediaObjectList(DataGroups dataGroups, Limits limits)
static Photo	generatePhoto(DataGroups dataGroups)
static PhotoList	generatePhotoList(DataGroups dataGroups, Limits limits, java.lang.Class<? extends PhotoList> cls)
static PhotoTaskDetails	generatePhotoTaskDetails(DataGroups dataGroups, Limits limits, AsyncTask.TaskType taskType)
static ResultInfo	generateResultInfo()
static RedirectResponse	generateTargetUrl(UserIdentity authenticatedUser, CAContentCore.ServiceType serviceId, java.lang.String guid)
static PhotoTaskResponse	generateTaskResponse(Limits limits)
static VisualShape	generateVisualShape()
static Response	getMediaObjects(UserIdentity authenticatedUser, DataGroups dataGroups, Limits limits, java.util.EnumSet<CAContentCore.ServiceType> serviceTypes, java.util.List<java.lang.String> mediaObjectIds)
static Response	getPhotos(UserIdentity authenticatedUser, java.util.List<java.lang.String> guids, DataGroups dataGroups, Limits limits, java.util.EnumSet<CAContentCore.ServiceType> serviceTypes, long[] userIdFilter)
static Response	queryTaskDetails(java.lang.Integer backendId, java.lang.Long taskId, DataGroups dataGroups, Limits limits)
static Response	queryTaskStatus(java.lang.Long taskId, DataGroups dataGroups, Limits limits)
static Response	searchByContent(UserIdentity authenticatedUser, java.util.EnumSet<PhotoParameters.AnalysisType> analysisTypes, java.lang.String url, DataGroups dataGroups, Limits limits, java.util.EnumSet<CAContentCore.ServiceType> serviceTypes, long[] userIdFilters) client API variant
static Response	searchByKeyword(UserIdentity authenticatedUser, java.util.List<java.lang.String> keywords, DataGroups dataGroups, Limits limits, java.util.EnumSet<CAContentCore.ServiceType> serviceTypes, long[] userIdFilters)
static Response	searchSimilarByContent(java.util.EnumSet<PhotoParameters.AnalysisType> analysisTypes, java.lang.String url, DataGroups dataGroups, Limits limits, java.util.EnumSet<CAContentCore.ServiceType> serviceTypes, long[] userIds) back-end API variant
static Response	searchSimilarById(java.util.EnumSet<PhotoParameters.AnalysisType> analysisTypes, java.lang.String guid, DataGroups dataGroups, Limits limits, java.util.EnumSet<CAContentCore.ServiceType> serviceTypes, long[] userIds) Back-end API variation of search by GUID
static Response	searchSimilarById(UserIdentity authenticatedUser, java.util.EnumSet<PhotoParameters.AnalysisType> analysisTypes, java.lang.String guid, DataGroups dataGroups, Limits limits, java.util.EnumSet<CAContentCore.ServiceType> serviceTypes, long[] userIdFilters) Client API variation of search by GUID
static void	similarityFeedback(UserIdentity authenticatedUser, PhotoFeedbackList feedbackList)
static Response	similarPhotosByObject(UserIdentity authenticatedUser, MediaObjectList objects, DataGroups dataGroups, Limits limits, java.util.EnumSet<CAContentCore.ServiceType> serviceTypes, long[] userIdFilters)
static void	taskFinished(PhotoTaskResponse response) This performs a trivial check for the task contents, checking for the presence of a few key values.
static void	updatePhotos(UserIdentity authenticatedUser, PhotoList photoList)

Methods inherited from class java.lang.Object

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

Method Detail

taskFinished

public static void taskFinished(PhotoTaskResponse response)

This performs a trivial check for the task contents, checking for the presence of a few key values. The validity of the actual task contents will not checked.

Parameters:

response -

addTask

public static void addTask(PhotoTaskDetails taskDetails)

This performs a trivial check for the task contents, checking for the presence of a few key values. The validity of the actual task contents will not be checked.

Parameters:

taskDetails -

addTaskAsyncCallback

public static void addTaskAsyncCallback(PhotoTaskDetails details,
                                        PhotoList photoList)

Call asynchronously the callback given in the details, returning an example task response

Parameters:

details -

photoList -

See Also:

PhotoTaskResponse

executeAsyncCallback

public static void executeAsyncCallback(org.apache.http.client.methods.HttpPost post)

Parameters:

post -

queryTaskDetails

public static Response queryTaskDetails(java.lang.Integer backendId,
                                        java.lang.Long taskId,
                                        DataGroups dataGroups,
                                        Limits limits)

Parameters:

backendId -

taskId -

dataGroups -

limits -

Returns:

an example response for the given values

queryTaskStatus

public static Response queryTaskStatus(java.lang.Long taskId,
                                       DataGroups dataGroups,
                                       Limits limits)

Parameters:

taskId -

dataGroups -

limits -

Returns:

an example response for the given values

searchSimilarByContent

public static Response searchSimilarByContent(java.util.EnumSet<PhotoParameters.AnalysisType> analysisTypes,
                                              java.lang.String url,
                                              DataGroups dataGroups,
                                              Limits limits,
                                              java.util.EnumSet<CAContentCore.ServiceType> serviceTypes,
                                              long[] userIds)

back-end API variant

Parameters:

analysisTypes -

serviceTypes -

url -

userIds -

dataGroups -

limits -

Returns:

an example response for the given values

searchSimilarById

public static Response searchSimilarById(java.util.EnumSet<PhotoParameters.AnalysisType> analysisTypes,
                                         java.lang.String guid,
                                         DataGroups dataGroups,
                                         Limits limits,
                                         java.util.EnumSet<CAContentCore.ServiceType> serviceTypes,
                                         long[] userIds)

Back-end API variation of search by GUID

Parameters:

analysisTypes - not used

serviceTypes -

guid -

userIds -

dataGroups -

limits -

Returns:

an example response for the given values

searchByKeyword

public static Response searchByKeyword(UserIdentity authenticatedUser,
                                       java.util.List<java.lang.String> keywords,
                                       DataGroups dataGroups,
                                       Limits limits,
                                       java.util.EnumSet<CAContentCore.ServiceType> serviceTypes,
                                       long[] userIdFilters)

Parameters:

authenticatedUser -

keywords -

dataGroups -

limits -

serviceTypes -

userIdFilters -

Returns:

an example response for the given values

searchSimilarById

public static Response searchSimilarById(UserIdentity authenticatedUser,
                                         java.util.EnumSet<PhotoParameters.AnalysisType> analysisTypes,
                                         java.lang.String guid,
                                         DataGroups dataGroups,
                                         Limits limits,
                                         java.util.EnumSet<CAContentCore.ServiceType> serviceTypes,
                                         long[] userIdFilters)

Client API variation of search by GUID

Parameters:

authenticatedUser -

analysisTypes -

guid -

dataGroups -

limits -

serviceTypes -

userIdFilters -

Returns:

an example response for the given values

generateTargetUrl

public static RedirectResponse generateTargetUrl(UserIdentity authenticatedUser,
                                                 CAContentCore.ServiceType serviceId,
                                                 java.lang.String guid)

Parameters:

authenticatedUser -

serviceId -

guid -

Returns:

an example response for the given values

similarPhotosByObject

public static Response similarPhotosByObject(UserIdentity authenticatedUser,
                                             MediaObjectList objects,
                                             DataGroups dataGroups,
                                             Limits limits,
                                             java.util.EnumSet<CAContentCore.ServiceType> serviceTypes,
                                             long[] userIdFilters)

Parameters:

authenticatedUser -

objects -

dataGroups -

limits -

serviceTypes -

userIdFilters -

Returns:

an example response for the given values

updatePhotos

public static void updatePhotos(UserIdentity authenticatedUser,
                                PhotoList photoList)

Parameters:

photoList -

authenticatedUser -

searchByContent

public static Response searchByContent(UserIdentity authenticatedUser,
                                       java.util.EnumSet<PhotoParameters.AnalysisType> analysisTypes,
                                       java.lang.String url,
                                       DataGroups dataGroups,
                                       Limits limits,
                                       java.util.EnumSet<CAContentCore.ServiceType> serviceTypes,
                                       long[] userIdFilters)

client API variant

Parameters:

url -

serviceTypes -

authenticatedUser -

analysisTypes -

userIdFilters -

dataGroups -

limits -

Returns:

an example response for the given values

getPhotos

public static Response getPhotos(UserIdentity authenticatedUser,
                                 java.util.List<java.lang.String> guids,
                                 DataGroups dataGroups,
                                 Limits limits,
                                 java.util.EnumSet<CAContentCore.ServiceType> serviceTypes,
                                 long[] userIdFilter)

Parameters:

authenticatedUser -

guids -

dataGroups -

limits -

serviceTypes -

userIdFilter -

Returns:

an example response for the given values

similarityFeedback

public static void similarityFeedback(UserIdentity authenticatedUser,
                                      PhotoFeedbackList feedbackList)

Parameters:

authenticatedUser -

feedbackList -

getMediaObjects

public static Response getMediaObjects(UserIdentity authenticatedUser,
                                       DataGroups dataGroups,
                                       Limits limits,
                                       java.util.EnumSet<CAContentCore.ServiceType> serviceTypes,
                                       java.util.List<java.lang.String> mediaObjectIds)

Parameters:

authenticatedUser -

dataGroups -

limits -

serviceTypes -

mediaObjectIds -

Returns:

an example response for the given values

deletePhotos

public static void deletePhotos(UserIdentity authenticatedUser,
                                java.util.List<java.lang.String> guids)

Parameters:

authenticatedUser -

guids -

generateFeedbackList

public static PhotoFeedbackList generateFeedbackList(Limits limits)

Parameters:

limits -

Returns:

generated feedback list

generatePhotoList

public static PhotoList generatePhotoList(DataGroups dataGroups,
                                          Limits limits,
                                          java.lang.Class<? extends PhotoList> cls)
                                   throws java.lang.IllegalArgumentException

Parameters:

dataGroups - has only effect for photo list, if null or empty, data groups all

limits -

cls -

Returns:

generated photo list

Throws:

java.lang.IllegalArgumentException

generateMediaObjectList

public static MediaObjectList generateMediaObjectList(DataGroups dataGroups,
                                                      Limits limits)

Parameters:

dataGroups - has only effect for photo list, if null or empty, data groups all

limits -

Returns:

generated media object list

generateTaskResponse

public static PhotoTaskResponse generateTaskResponse(Limits limits)

Parameters:

limits -

Returns:

generated task response

generatePhotoTaskDetails

public static PhotoTaskDetails generatePhotoTaskDetails(DataGroups dataGroups,
                                                        Limits limits,
                                                        AsyncTask.TaskType taskType)
                                                 throws java.lang.IllegalArgumentException

Parameters:

dataGroups - has only effect for photo list, if null or empty, data groups all

limits -

taskType -

Returns:

generated task details

Throws:

java.lang.IllegalArgumentException

generateBackendStatusList

public static BackendStatusList generateBackendStatusList(Limits limits)

Parameters:

limits -

Returns:

generated back-end status list

generatePhoto

public static Photo generatePhoto(DataGroups dataGroups)

Parameters:

dataGroups - has only effect for photo list, if null or empty, data groups all

Returns:

generated photo

generateBackendStatus

public static BackendStatus generateBackendStatus()

Returns:

generated back-end status

generateResultInfo

public static ResultInfo generateResultInfo()

Returns:

generated result info

generateMediaObject

public static MediaObject generateMediaObject(DataGroups dataGroups)

Parameters:

dataGroups - has only effect for photo list, if null or empty, data groups all

Returns:

generated media object

generateVisualShape

public static VisualShape generateVisualShape()

Returns:

generated visual shape

generateAnalysisBackend

public static AnalysisBackend generateAnalysisBackend()

Returns:

generated analysis back-end

generateAnalysisParameters

public static PhotoParameters generateAnalysisParameters()

Returns:

randomly generated analysis parameters