service.tut.pori.contentanalysis

Class Photo

java.lang.Object

service.tut.pori.contentanalysis.Media

service.tut.pori.contentanalysis.Photo

public class Photo
extends Media

Contains metadata information of a single photo.

Optional elements

• backendStatusList
• confidence
• credits
• description
• name
• objectList
• visibility

Back-end Photo List elements

Certain elements are not applicable when Photo is used with back-end responses. The following elements can be omitted in back-end responses:

• serviceId
• url
• userId

The elements will be ignored, and thus, will not cause errors.

XML Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<media>
  <credits>JpARFpKzCWfrNOWmWSHIzHdyFzHDVYSUzkScIGmlNgcoJCqqXXCivhsvqsCOoVdb</credits>
  <description>ndNqnkwModQGnGxGRYDGRoWmzqxBAGeCpqfnRpczBYwYWBBKwbLMzEehFHctCLXC</description>
  <UID>ef6b901b-0253-470c-8ca2-36ac7bb52533</UID>
  <name>XNQmSaQlMTTpTiHAJVemcmxnFfKqjTdSUcVHQYRyvFewzLbDmSAQVkUFQdgZjvCw</name>
  <serviceId>4</serviceId>
  <visibility>PUBLIC</visibility>
  <objectList>
    <object>
      <backendId>196503983</backendId>
      <confidence>0.9103115364950308</confidence>
      <mediaObjectId>3414249424978964565</mediaObjectId>
      <mediaType>PHOTO</mediaType>
      <objectId>fAKxXhlOJPYWGLyYZsdEMkvHtBsvrajrxXzAWasOTrxbdYZDRBTsvzkBZPKQVRHZ</objectId>
      <rank>1505192548</rank>
      <serviceId>6</serviceId>
      <status>USER_REJECTED</status>
      <objectType>KEYWORD</objectType>
      <value>GNVkCMrtJXsnNERrxjRiSkspOqaMUoyBbseqyRDeTyfEpjDdnMNpqWdEEKsRSvvC</value>
      <visibility>GROUP</visibility>
      <userId>3421680948487249354</userId>
    </object>
  </objectList>
  <mediaType>PHOTO</mediaType>
  <userId>3421680948487249354</userId>
  <url>http://fe.example.org/rest/carc/r?uid=ef6b901b-0253-470c-8ca2-36ac7bb52533&amp;service_id=4</url>
</media>

See Also:

BackendStatusList, MediaObjectList

Field Summary

Fields

Modifier and Type	Field and Description
static MediaUrlValidator.MediaType	MEDIA_TYPE Default media type for photo

Constructor Summary

Constructors

Constructor and Description
Photo() for serialization, must be public for solr.
Photo(java.lang.String guid)
Photo(java.lang.String guid, UserIdentity ownerUserId, CAContentCore.ServiceType serviceType, CAContentCore.Visibility visibility)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getUrl() If URL is not set, this will try to generate default redirect URL with serviceId, and GUID, finally, returns null if the required information is not available.
void	setMediaType(MediaUrlValidator.MediaType mediaType)

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

addackendStatus, addMediaObject, addMediaObjects, getBackendStatus, getCredits, getDescription, getGUID, getMediaObjects, getMediaType, getMediaTypeValue, getName, getOwnerUserId, getOwnerUserIdValue, getServiceId, getServiceType, getUpdated, getVisibility, getVisibilityValue, isValid, setBackendStatus, setCredits, setDescription, setGUID, setMediaObjects, setName, setOwnerUserId, setServiceType, setUpdated, setUrl, setVisibility

Methods inherited from class java.lang.Object

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

Field Detail

MEDIA_TYPE

public static final MediaUrlValidator.MediaType MEDIA_TYPE

Default media type for photo

Constructor Detail

Photo

public Photo()

for serialization, must be public for solr.

Photo

public Photo(java.lang.String guid)

Parameters:

guid -

Photo

public Photo(java.lang.String guid,
             UserIdentity ownerUserId,
             CAContentCore.ServiceType serviceType,
             CAContentCore.Visibility visibility)

Parameters:

guid -

ownerUserId -

serviceType -

visibility -

Method Detail

getUrl

public java.lang.String getUrl()

If URL is not set, this will try to generate default redirect URL with serviceId, and GUID, finally, returns null if the required information is not available. Default data groups: basic, defaults

Overrides:

getUrl in class Media

Returns:

URL

See Also:

Media.setUrl(String)

setMediaType

public void setMediaType(MediaUrlValidator.MediaType mediaType)
                  throws java.lang.IllegalArgumentException

Overrides:

setMediaType in class Media

Parameters:

mediaType - if null, the default media type will be used

Throws:

java.lang.IllegalArgumentException - on bad media type, i.e. not the default media or null

See Also:

MEDIA_TYPE