PhotoTaskDetails (CAFrontEnd API Specification)

java.lang.Object
- core.tut.pori.http.ResponseData
- - service.tut.pori.contentanalysis.AbstractTaskDetails
  - - service.tut.pori.contentanalysis.PhotoTaskDetails

public final class PhotoTaskDetails
extends AbstractTaskDetails

An implementation of AbstractTaskDetails, which can be used to define a photo analysis task, or a feedback task.

Conditional Elements

One of mediaList, referenceMediaList or deletedMediaList must be present in a task. If dissimilarMediaList or similarMediaList is present, referenceMediaList must be present. When including SimilarPhotoList and/or DissimilarPhotoList, it is recommended to provide only a single reference photo in the ReferencePhotoList, and the photos should not contain media objects with updated metadata (i.e. media object feedback). For the media object feedback, a separate feedback task should be generated. For tasks of type AsyncTask.TaskType.ANALYSIS and AsyncTask.TaskType.BACKEND_FEEDBACK, the valid list is PhotoList, and for tasks of type AsyncTask.TaskType.FEEDBACK the valid lists are DeletedPhotoList, DissimilarPhotoList, ReferencePhotoList and SimilarPhotoList.

Optional Elements

backendStatusList
userConfidence, recommended values are 0...1 normalized, though other values are also accepted.

XML Example - Analysis Task

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<taskDetails>
  <backendId>471551117</backendId>
  <taskId>1378727252259501697</taskId>
  <taskType>ANALYSIS</taskType>
  <callbackUri>http://fe.example.org/rest/cars/taskFinished</callbackUri>
  <taskParameters>
    <analysisTypeList>
      <analysisType>FACE_DETECTION</analysisType>
      <analysisType>KEYWORD_EXTRACTION</analysisType>
      <analysisType>VISUAL</analysisType>
    </analysisTypeList>
  </taskParameters>
  <userId>5651331966575954185</userId>
  <mediaList>
    <media>
      <credits>JGVKaVKbSeQtWbPwKryAadThdoYmBzqedqBmdIVovaLvqviZRMjXsXSHvoKQJExT</credits>
      <description>DQGCOQLmZSoBBQpKQvSKJmunznnUNrTqSDwRGvfmDHmxvHxLiBMYQZYnomWgHTeJ</description>
      <UID>71c49f72-74a9-440e-9fb1-04c6493a8fde</UID>
      <name>vMBKgOvEohIHFyinsTVcEKIqQIyzEBduRlNzBZYFExIYrOMrCFlPjpZEqEgyKfSZ</name>
      <serviceId>1</serviceId>
      <visibility>GROUP</visibility>
      <objectList>
        <object>
          <backendId>807998609</backendId>
          <confidence>0.6985345915681368</confidence>
          <mediaObjectId>5096748399360700864</mediaObjectId>
          <mediaType>PHOTO</mediaType>
          <objectId>ucntfVXOqKjimUqrcCrQjxsZqzRxKTOXjgaDMUiZuvqXZshiezcwrDboHShQFzco</objectId>
          <rank>1150269330</rank>
          <serviceId>6</serviceId>
          <status>CANDIDATE</status>
          <objectType>KEYWORD</objectType>
          <value>TrdLiFGmhAxBeEryXvfMogpYHQcyZtfCvfIRrZiqHAraWfXaeIxPztYvOkiKUsDD</value>
          <visibility>GROUP</visibility>
          <userId>5651331966575954185</userId>
        </object>
      </objectList>
      <mediaType>PHOTO</mediaType>
      <userId>5651331966575954185</userId>
      <url>http://fe.example.org/rest/carc/r?uid=71c49f72-74a9-440e-9fb1-04c6493a8fde&amp;service_id=1</url>
    </media>
  </mediaList>
</taskDetails>

XML Example - Backend Feedback Task

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<taskDetails>
  <backendId>295522108</backendId>
  <taskId>6091923708826463887</taskId>
  <taskType>BACKEND_FEEDBACK</taskType>
  <callbackUri>http://fe.example.org/rest/cars/taskFinished</callbackUri>
  <taskParameters>
    <analysisTypeList>
      <analysisType>FACE_DETECTION</analysisType>
      <analysisType>KEYWORD_EXTRACTION</analysisType>
      <analysisType>VISUAL</analysisType>
    </analysisTypeList>
  </taskParameters>
  <userId>8854890180605275902</userId>
  <mediaList>
    <media>
      <credits>VgwsOPxshCgyhPWCEvBDaPkrsHSdueDhFRScEmtsqlmusLzPSaGvcmaOUZxKgjqG</credits>
      <description>gFRZZvkgaKTxDdKwLGydIClVLiVyUuHNlCnPfwGOqkuhOlWGMJSArSGqzfcfYbdW</description>
      <UID>884a2559-11d3-4611-80a1-8fafca8c6522</UID>
      <name>JMdpJZZFNduUCLKQRyfmAgQqymdKbHcbVImXASvBGdPwGVCbuoCGBFrtCCjLfDPL</name>
      <serviceId>6</serviceId>
      <visibility>PUBLIC</visibility>
      <objectList>
        <object>
          <backendId>1453343072</backendId>
          <confidence>0.47309048285446154</confidence>
          <mediaObjectId>1950101601717108612</mediaObjectId>
          <mediaType>PHOTO</mediaType>
          <objectId>RINSvRqjXrzxrHwZMVPHTbzHfSXSTEEYEtBzYdKdPwvUuzulKxGXAzbSukttwDUt</objectId>
          <rank>1367105213</rank>
          <serviceId>6</serviceId>
          <status>CANDIDATE</status>
          <objectType>KEYWORD</objectType>
          <value>wpIVJQoJLpeddxjaomAUQXTBdvYMHFAmiVFrAMJCJEKjWSMWdSmrbnCmqEffJqML</value>
          <visibility>PUBLIC</visibility>
          <userId>8854890180605275902</userId>
        </object>
      </objectList>
      <mediaType>PHOTO</mediaType>
      <userId>8854890180605275902</userId>
      <url>http://fe.example.org/rest/carc/r?uid=884a2559-11d3-4611-80a1-8fafca8c6522&amp;service_id=6</url>
    </media>
  </mediaList>
</taskDetails>

XML Example - Feedback Task

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<taskDetails>
  <backendId>311797085</backendId>
  <taskId>7612897666964009233</taskId>
  <taskType>FEEDBACK</taskType>
  <callbackUri>http://fe.example.org/rest/cars/taskFinished</callbackUri>
  <taskParameters>
    <analysisTypeList>
      <analysisType>FACE_DETECTION</analysisType>
      <analysisType>KEYWORD_EXTRACTION</analysisType>
      <analysisType>VISUAL</analysisType>
    </analysisTypeList>
  </taskParameters>
  <userId>5060870059696750463</userId>
  <dissimilarMediaList>
    <media>
      <UID>ba5ea86e-1308-4e57-963e-c1df91de8e7a</UID>
      <serviceId>6</serviceId>
      <mediaType>PHOTO</mediaType>
      <userId>6163040006737610253</userId>
      <url>http://fe.example.org/rest/carc/r?uid=ba5ea86e-1308-4e57-963e-c1df91de8e7a&amp;service_id=6</url>
    </media>
  </dissimilarMediaList>
  <similarMediaList>
    <media>
      <UID>ce33658c-6c17-4630-ba3f-3d1920fe8819</UID>
      <serviceId>1</serviceId>
      <mediaType>PHOTO</mediaType>
      <userId>3910564330661476731</userId>
      <url>http://fe.example.org/rest/carc/r?uid=ce33658c-6c17-4630-ba3f-3d1920fe8819&amp;service_id=1</url>
    </media>
  </similarMediaList>
  <referenceMediaList>
    <media>
      <UID>8608045255601043468</UID>
      <mediaType>PHOTO</mediaType>
    </media>
  </referenceMediaList>
  <userConfidence>0.8031709659509181</userConfidence>
</taskDetails>

See Also:: DeletedPhotoList, DissimilarPhotoList, SimilarPhotoList, PhotoList, ReferencePhotoList

Nested Class Summary
- Nested classes/interfaces inherited from class service.tut.pori.contentanalysis.AbstractTaskDetails
  AbstractTaskDetails.TaskParameters

Constructor Summary

Constructors
Constructor and Description

PhotoTaskDetails()

PhotoTaskDetails(AsyncTask.TaskType type)

Constructors
Constructor and Description
`PhotoTaskDetails()`
`PhotoTaskDetails(AsyncTask.TaskType type)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDeletedPhoto(Photo photo)`
`void`	`addDissimilarPhoto(Photo photo)`
`void`	`addPhoto(Photo photo)`
`void`	`addReferencePhoto(Photo photo)`
`void`	`addSimilarPhoto(Photo photo)`
`static java.lang.String`	`generateFinishedCallbackUri()`
`java.lang.String`	`getCallbackUri()`
`DeletedPhotoList`	`getDeletedPhotoList()`
`DissimilarPhotoList`	`getDissimilarPhotoList()`
`java.util.Map<java.lang.String,java.lang.String>`	`getMetadata()`
`PhotoList`	`getPhotoList()`
`ReferencePhotoList`	`getReferencePhotoList()`
`SimilarPhotoList`	`getSimilarPhotoList()`
`PhotoParameters`	`getTaskParameters()`
`java.lang.Double`	`getUserConfidence()`
`boolean`	`isEmpty()`
`void`	`setDeletedPhotoList(DeletedPhotoList deletedPhotoList)`
`void`	`setDissimilarPhotoList(DissimilarPhotoList dissimilarPhotoList)`
`void`	`setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)`
`void`	`setPhotoList(PhotoList photoList)`
`void`	`setReferencePhotoList(ReferencePhotoList referencePhotoList)`
`void`	`setSimilarPhotoList(SimilarPhotoList similarPhotoList)`
`void`	`setTaskParameters(AbstractTaskDetails.TaskParameters parameters)`
`void`	`setTaskParameters(PhotoParameters parameters)`
`void`	`setUserConfidence(java.lang.Double userConfidence)`

Methods inherited from class service.tut.pori.contentanalysis.AbstractTaskDetails
getBackendId, getBackends, getDataClasses, getTaskId, getTaskType, getUserId, getUserIdValue, setBackend, setBackendId, setBackends, setCallbackUri, setTaskId, setTaskType, setUserId

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PhotoTaskDetails
```
public PhotoTaskDetails()
```
  - PhotoTaskDetails
```
public PhotoTaskDetails(AsyncTask.TaskType type)
```
    Parameters:
    
    type -
- Method Detail
  - getPhotoList
```
public PhotoList getPhotoList()
```
    Returns:
    
    photo list
  - setPhotoList
```
public void setPhotoList(PhotoList photoList)
```
    Parameters:
    
    photoList -
    
    See Also:
    
    getPhotoList()
  - getDeletedPhotoList
```
public DeletedPhotoList getDeletedPhotoList()
```
    Returns:
    
    list of deleted photos
    
    See Also:
    
    setDeletedPhotoList(DeletedPhotoList)
  - setDeletedPhotoList
```
public void setDeletedPhotoList(DeletedPhotoList deletedPhotoList)
```
    Parameters:
    
    deletedPhotoList -
    
    See Also:
    
    getDeletedPhotoList()
  - getSimilarPhotoList
```
public SimilarPhotoList getSimilarPhotoList()
```
    Returns:
    
    list of photos similar to reference photos
    
    See Also:
    
    getReferencePhotoList(), setSimilarPhotoList(SimilarPhotoList)
  - setSimilarPhotoList
```
public void setSimilarPhotoList(SimilarPhotoList similarPhotoList)
```
    Parameters:
    
    similarPhotoList -
    
    See Also:
    
    getSimilarPhotoList()
  - getDissimilarPhotoList
```
public DissimilarPhotoList getDissimilarPhotoList()
```
    Returns:
    
    list of photos dissimilar to the reference photos
    
    See Also:
    
    getReferencePhotoList(), setDissimilarPhotoList(DissimilarPhotoList)
  - setDissimilarPhotoList
```
public void setDissimilarPhotoList(DissimilarPhotoList dissimilarPhotoList)
```
    Parameters:
    
    dissimilarPhotoList -
    
    See Also:
    
    getDissimilarPhotoList()
  - getReferencePhotoList
```
public ReferencePhotoList getReferencePhotoList()
```
    Returns:
    
    reference photos for similar and/or dissimilar photos
    
    See Also:
    
    getDissimilarPhotoList(), getSimilarPhotoList(), setReferencePhotoList(ReferencePhotoList)
  - setReferencePhotoList
```
public void setReferencePhotoList(ReferencePhotoList referencePhotoList)
```
    Parameters:
    
    referencePhotoList - the referencePhotoList to set
    
    See Also:
    
    getReferencePhotoList()
  - addReferencePhoto
```
public void addReferencePhoto(Photo photo)
```
    Parameters:
    
    photo -
    
    See Also:
    
    getReferencePhotoList()
  - addPhoto
```
public void addPhoto(Photo photo)
```
    Parameters:
    
    photo -
    
    See Also:
    
    getPhotoList()
  - addDeletedPhoto
```
public void addDeletedPhoto(Photo photo)
```
    Parameters:
    
    photo -
    
    See Also:
    
    getDeletedPhotoList()
  - addSimilarPhoto
```
public void addSimilarPhoto(Photo photo)
```
    Parameters:
    
    photo -
    
    See Also:
    
    getSimilarPhotoList()
  - addDissimilarPhoto
```
public void addDissimilarPhoto(Photo photo)
```
    Parameters:
    
    photo -
    
    See Also:
    
    getDissimilarPhotoList()
  - isEmpty
```
public boolean isEmpty()
```
    Returns:
    
    true if no photo lists are given or the lists are empty
  - getUserConfidence
```
public java.lang.Double getUserConfidence()
```
    Returns:
    
    confidence of the task owner, or null if unknown
    
    See Also:
    
    setUserConfidence(Double)
  - setUserConfidence
```
public void setUserConfidence(java.lang.Double userConfidence)
```
    Parameters:
    
    userConfidence -
    
    See Also:
    
    getUserConfidence()
  - getMetadata
```
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
```
    Overrides:
    
    getMetadata in class AbstractTaskDetails
    
    Returns:
    
    the metadata
    
    See Also:
    
    AbstractTaskDetails.setMetadata(Map)
  - setMetadata
```
public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
```
    Overrides:
    
    setMetadata in class AbstractTaskDetails
    
    Parameters:
    
    metadata - the metadata to set
    
    See Also:
    
    AbstractTaskDetails.getMetadata()
  - getCallbackUri
```
public java.lang.String getCallbackUri()
```
    Overrides:
    
    getCallbackUri in class AbstractTaskDetails
    
    Returns:
    
    callback uri
    
    See Also:
    
    AbstractTaskDetails.setCallbackUri(String)
  - generateFinishedCallbackUri
```
public static java.lang.String generateFinishedCallbackUri()
```
    Returns:
    
    the default task finished callback uri
  - getTaskParameters
```
public PhotoParameters getTaskParameters()
```
    Specified by:
    
    getTaskParameters in class AbstractTaskDetails
    
    Returns:
    
    the parameters
    
    See Also:
    
    AbstractTaskDetails.setTaskParameters(TaskParameters)
  - setTaskParameters
```
public void setTaskParameters(AbstractTaskDetails.TaskParameters parameters)
```
    Specified by:
    
    setTaskParameters in class AbstractTaskDetails
    
    Parameters:
    
    parameters - the parameters to set
    
    See Also:
    
    AbstractTaskDetails.getTaskParameters()
  - setTaskParameters
```
public void setTaskParameters(PhotoParameters parameters)
```
    Parameters:
    
    parameters -

Class PhotoTaskDetails

Conditional Elements

Optional Elements

XML Example - Analysis Task

XML Example - Backend Feedback Task

XML Example - Feedback Task

Nested Class Summary

Nested classes/interfaces inherited from class service.tut.pori.contentanalysis.AbstractTaskDetails

Constructor Summary

Method Summary

Methods inherited from class service.tut.pori.contentanalysis.AbstractTaskDetails

Methods inherited from class java.lang.Object

Constructor Detail

PhotoTaskDetails

PhotoTaskDetails

Method Detail

getPhotoList

setPhotoList

getDeletedPhotoList

setDeletedPhotoList

getSimilarPhotoList

setSimilarPhotoList

getDissimilarPhotoList

setDissimilarPhotoList

getReferencePhotoList

setReferencePhotoList

addReferencePhoto

addPhoto

addDeletedPhoto

addSimilarPhoto

addDissimilarPhoto

isEmpty

getUserConfidence

setUserConfidence

getMetadata

setMetadata

getCallbackUri

generateFinishedCallbackUri

getTaskParameters

setTaskParameters

setTaskParameters