service.tut.pori.contentanalysis

Class AbstractTaskDetails

java.lang.Object

core.tut.pori.http.ResponseData

service.tut.pori.contentanalysis.AbstractTaskDetails

Direct Known Subclasses:

ContentStorageCore.SynchronizationTaskDetails, FBFeedbackTaskDetails, FBSummarizationTaskDetails, FBTaskDetails, PhotoTaskDetails, TaskDetails, TwitterSummarizationTaskDetails, TwitterTaskDetails, VideoTaskDetails

public abstract class AbstractTaskDetails
extends ResponseData

The base class for task details (task workload). Contains basic members and functionality needed for task submission. Note: remember to define \@XmlRootElement(name=ELEMENT_NAME) for your inherited class

Optional Elements

• userId, missing if task is generated by the system, or the task is anonymous.
• taskParameters. The parameters depend on the task in question. If the element is missing the back-ends should run back-end specific default operation.

See Also:

BackendStatusList

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractTaskDetails.TaskParameters Abstract base class for optional task parameters.

Constructor Summary

Constructors

Constructor and Description
AbstractTaskDetails()

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getBackendId()
BackendStatusList	getBackends() Default data groups: backend_status
java.lang.String	getCallbackUri()
java.lang.Class<?>[]	getDataClasses() The default implementation equals to calling getClass(), override this if your class requires other classes for serialization purposes (which cannot be directly resolved).
java.util.Map<java.lang.String,java.lang.String>	getMetadata()
java.lang.Long	getTaskId()
abstract AbstractTaskDetails.TaskParameters	getTaskParameters()
AsyncTask.TaskType	getTaskType()
UserIdentity	getUserId()
java.lang.Long	getUserIdValue()
void	setBackend(BackendStatus status)
void	setBackendId(java.lang.Integer backendId)
void	setBackends(BackendStatusList backends)
void	setCallbackUri(java.lang.String callbackUri) Can be used to override the default, generated call back uri
void	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
void	setTaskId(java.lang.Long taskId)
abstract void	setTaskParameters(AbstractTaskDetails.TaskParameters parameters)
void	setTaskType(AsyncTask.TaskType type)
void	setUserId(UserIdentity userId)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTaskDetails

public AbstractTaskDetails()

Method Detail

getUserIdValue

public java.lang.Long getUserIdValue()

Returns:

the value of user identity

See Also:

getUserId()

getUserId

public UserIdentity getUserId()

Returns:

user identity

See Also:

setUserId(UserIdentity)

setUserId

public void setUserId(UserIdentity userId)

Parameters:

userId -

See Also:

getUserId()

setTaskType

public void setTaskType(AsyncTask.TaskType type)

Parameters:

type -

See Also:

getTaskType()

getTaskType

public AsyncTask.TaskType getTaskType()

Returns:

task type

See Also:

setTaskType(service.tut.pori.contentanalysis.AsyncTask.TaskType)

getBackendId

public java.lang.Integer getBackendId()

Returns:

back-end id of the first back-end in the status list

See Also:

getBackendId()

setBackendId

public void setBackendId(java.lang.Integer backendId)

Parameters:

backendId -

See Also:

getBackendId()

getTaskId

public java.lang.Long getTaskId()

Returns:

task id

See Also:

setTaskId(Long)

setTaskId

public void setTaskId(java.lang.Long taskId)

Parameters:

taskId -

See Also:

getTaskId()

getCallbackUri

public java.lang.String getCallbackUri()

Returns:

callback uri

See Also:

setCallbackUri(String)

setCallbackUri

public void setCallbackUri(java.lang.String callbackUri)

Can be used to override the default, generated call back uri

Parameters:

callbackUri -

See Also:

getCallbackUri()

getBackends

public BackendStatusList getBackends()

Default data groups: backend_status

Returns:

the backends

See Also:

setBackends(BackendStatusList)

setBackends

public void setBackends(BackendStatusList backends)

Parameters:

backends - the backends to set

See Also:

getBackends()

setBackend

public void setBackend(BackendStatus status)

Parameters:

status -

See Also:

getBackends()

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Returns:

the metadata

See Also:

setMetadata(Map)

setMetadata

public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

Parameters:

metadata - the metadata to set

See Also:

getMetadata()

getDataClasses

public java.lang.Class<?>[] getDataClasses()

Description copied from class: ResponseData

The default implementation equals to calling getClass(), override this if your class requires other classes for serialization purposes (which cannot be directly resolved). In general, overriding the default class definitions should not be needed, and in many cases an attempt to do so may be a sign of bad design, though there might also be valid cases where the functionality is required.

Overrides:

getDataClasses in class ResponseData

Returns:

the list of classes present in this data

getTaskParameters

public abstract AbstractTaskDetails.TaskParameters getTaskParameters()

Returns:

the parameters

See Also:

setTaskParameters(TaskParameters)

setTaskParameters

public abstract void setTaskParameters(AbstractTaskDetails.TaskParameters parameters)

Parameters:

parameters - the parameters to set

See Also:

getTaskParameters()