service.tut.pori.contentanalysis

Class PhotoSearchTask

java.lang.Object

service.tut.pori.contentanalysis.PhotoSearchTask

public class PhotoSearchTask
extends java.lang.Object

Search task used to query back-ends for results. This class is not asynchronous and will block for the duration of execution, also this task cannot be submitted to system schedulers.

Field Summary

Fields

Modifier and Type	Field and Description
static AnalysisBackend.Capability	SEARCH_CAPABILITY Back-end capability required for search tasks

Method Summary

Modifier and Type	Method and Description
PhotoList	execute() Execute this task
static PhotoSearchTask	getTaskByGUID(UserIdentity authenticatedUser, java.util.EnumSet<PhotoParameters.AnalysisType> analysisTypes, DataGroups dataGroups, java.lang.String guid, Limits limits, java.util.EnumSet<CAContentCore.ServiceType> serviceTypeFilter, long[] userIdFilter) Create new search task using the GUID as a reference, the GUID is assumed to exist, no database lookup is going to be done to confirm it
static PhotoSearchTask	getTaskByUrl(UserIdentity authenticatedUser, java.util.EnumSet<PhotoParameters.AnalysisType> analysisTypes, DataGroups dataGroups, Limits limits, java.util.EnumSet<CAContentCore.ServiceType> serviceTypeFilter, java.lang.String url, long[] userIdFilter) Create new search task using the URL as a search parameter.

Methods inherited from class java.lang.Object

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

Field Detail

SEARCH_CAPABILITY

public static final AnalysisBackend.Capability SEARCH_CAPABILITY

Back-end capability required for search tasks

Method Detail

execute

public PhotoList execute()

Execute this task

Returns:

results of the search or null if no results

getTaskByGUID

public static PhotoSearchTask getTaskByGUID(UserIdentity authenticatedUser,
                                            java.util.EnumSet<PhotoParameters.AnalysisType> analysisTypes,
                                            DataGroups dataGroups,
                                            java.lang.String guid,
                                            Limits limits,
                                            java.util.EnumSet<CAContentCore.ServiceType> serviceTypeFilter,
                                            long[] userIdFilter)
                                     throws java.lang.IllegalArgumentException

Create new search task using the GUID as a reference, the GUID is assumed to exist, no database lookup is going to be done to confirm it

Parameters:

authenticatedUser - optional authenticated user

analysisTypes -

dataGroups - optional data groups

guid -

limits - optional limits

serviceTypeFilter - optional service type filter

userIdFilter - optional user id filter, if given only the content for the specific users will searched for

Returns:

new task

Throws:

java.lang.IllegalArgumentException - on bad GUID

getTaskByUrl

public static PhotoSearchTask getTaskByUrl(UserIdentity authenticatedUser,
                                           java.util.EnumSet<PhotoParameters.AnalysisType> analysisTypes,
                                           DataGroups dataGroups,
                                           Limits limits,
                                           java.util.EnumSet<CAContentCore.ServiceType> serviceTypeFilter,
                                           java.lang.String url,
                                           long[] userIdFilter)
                                    throws java.lang.IllegalArgumentException

Create new search task using the URL as a search parameter. The URL is assumed to be valid, and no validation is performed.

Parameters:

authenticatedUser - optional authenticated user

analysisTypes -

dataGroups - optional data groups

limits - optional limits

serviceTypeFilter - optional service type filter

url -

userIdFilter - optional user id filter, if given only the content for the specific users will searched for

Returns:

new task

Throws:

java.lang.IllegalArgumentException - on bad URL