MediaObject (CAFrontEnd API Specification)

java.lang.Object
- service.tut.pori.contentanalysis.MediaObject

All Implemented Interfaces:

VisualShape.VisualShapeSolrCapable
```
public class MediaObject
extends java.lang.Object
implements VisualShape.VisualShapeSolrCapable
```
A class that defines a single media object. All media objects are by default of type MediaUrlValidator.MediaType.UNKNOWN}.

Note: when using this class, never pass partial objects to database methods, missing information (e.g. value == null) may be assumed to be marked as "deleted", and will be removed from the database.

Media objects are objects which were identified from the content given for analysis (e.g. from photos).

Back-ends may only edit objects which have been created by them (checked by objectId, getObjectId() and backendId, getBackendId()). Back-ends may not edit objects which have been confirmed by the user.

If a back-end wants to modify an object created by another back-end, it must generate and submit a new (MediaObject.ConfirmationStatus.CANDIDATE) media object.

Optional Elements
- backendId, missing if the object is not generated by a back-end.
- value
- name
- confidence, missing value means that the confidence is unknown.
- objectId, may not be present on objects created by the system.
- mediaType, if omitted it will default to MediaUrlValidator.MediaType.UNKNOWN OR if object is part of a container object, such as Media the container's type will be used (see Media.getMediaType()).
- mediaObjectId, can be omitted (and is ignored) for new objects. Automatically generated by the system.
- rank, if missing, the value should be assumed to be 0 (neutral).
- resultInfo
- serviceId, not present for objects created by user or a back-end.
- timeCodeList. If timecode list is missing or is empty, the object is assumed to describe the entire content.
- shape
- visibility, if missing should be assumed to be CAContentCore.Visibility.PRIVATE.
XML Example
```
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<object>
  <backendId>811294222</backendId>
  <confidence>0.20135624842974498</confidence>
  <mediaObjectId>8102478566423944712</mediaObjectId>
  <mediaType>PHOTO</mediaType>
  <objectId>xehekOwUiFuQlVNngAtuehiBZELdxtjgOfxsyjzlQsWanftQWOGeVWeiZpcvsosa</objectId>
  <rank>1202910753</rank>
  <serviceId>6</serviceId>
  <status>USER_CONFIRMED</status>
  <objectType>KEYWORD</objectType>
  <value>RRPByJYExeiXMCyBhHAiaLUAhmnYgGmFncCFGpsplJdKWIrYMYrvIUyylboEFHvX</value>
  <visibility>PUBLIC</visibility>
  <userId>696722578499386597</userId>
</object>
```
See Also:

VisualShape

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MediaObject.ConfirmationStatus` The confirmation status of the media object.
`static class`	`MediaObject.MediaObjectType` The type of the media object.

Constructor Summary

Constructors
Constructor and Description
`MediaObject()` for serialization, must be public for solr.
`MediaObject(MediaUrlValidator.MediaType mediaType, MediaObject.MediaObjectType mediaObjectType)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Integer`	`getBackendId()`
`java.lang.Double`	`getConfidence()`
`MediaObject.ConfirmationStatus`	`getConfirmationStatus()`
`java.lang.Integer`	`getConfirmationStatusValue()`
`java.lang.String`	`getMediaObjectId()` Internally generated, unique Id.
`MediaObject.MediaObjectType`	`getMediaObjectType()`
`java.lang.Integer`	`getMediaObjectTypeValue()`
`MediaUrlValidator.MediaType`	`getMediaType()`
`java.lang.Integer`	`getMediaTypeValue()`
`java.lang.String`	`getName()`
`java.lang.String`	`getObjectId()` Generally externally generated id, unique only when used in combination with back-end id, or if back-end id is missing, with user id.
`UserIdentity`	`getOwnerUserId()`
`java.lang.Long`	`getOwnerUserIdValue()`
`java.lang.Integer`	`getRank()`
`java.lang.Integer`	`getServiceId()`
`CAContentCore.ServiceType`	`getServiceType()`
`java.util.List<java.lang.String>`	`getSolrTimecodes()` Solr serializing helper method
`TimecodeList`	`getTimecodes()`
`java.util.Date`	`getUpdated()`
`java.lang.String`	`getValue()`
`CAContentCore.Visibility`	`getVisibility()`
`java.lang.Integer`	`getVisibilityValue()`
`VisualShape`	`getVisualShape()`
`java.lang.Integer`	`getVisualShapeTypeId()`
`java.lang.String`	`getVisualShapeValue()`
`static boolean`	`isValid(MediaObject object)`
`void`	`setBackendId(java.lang.Integer backendId)`
`void`	`setConfidence(java.lang.Double confidence)`
`void`	`setConfirmationStatus(MediaObject.ConfirmationStatus status)`
`void`	`setMediaObjectId(java.lang.String id)`
`void`	`setMediaObjectType(MediaObject.MediaObjectType type)`
`void`	`setMediaType(MediaUrlValidator.MediaType mediaType)`
`void`	`setName(java.lang.String name)`
`void`	`setObjectId(java.lang.String objectId)`
`void`	`setOwnerUserId(UserIdentity userId)`
`void`	`setRank(java.lang.Integer rank)`
`void`	`setServiceType(CAContentCore.ServiceType serviceType)`
`void`	`setSolrTimecodes(java.util.List<java.lang.String> timecodes)` Solr serializing helper method
`void`	`setTimecodes(TimecodeList timecodes)`
`void`	`setUpdated(java.util.Date updated)`
`void`	`setValue(java.lang.String value)`
`void`	`setVisibility(CAContentCore.Visibility visibility)`
`void`	`setVisualShape(VisualShape shape)`
`void`	`setVisualShapeTypeId(java.lang.Integer type)`
`void`	`setVisualShapeValue(java.lang.String value)`

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

- Constructor Detail
  - MediaObject
```
public MediaObject()
```
    for serialization, must be public for solr.
  - MediaObject
```
public MediaObject(MediaUrlValidator.MediaType mediaType,
                   MediaObject.MediaObjectType mediaObjectType)
```
    Parameters:
    
    mediaType -
    
    mediaObjectType -
- Method Detail
  - getConfidence
```
public java.lang.Double getConfidence()
```
    Returns:
    
    confidence estimate for this object, if < 1 or null, the confidence is assumed to be unknown.
    
    See Also:
    
    setConfidence(Double)
  - setConfidence
```
public void setConfidence(java.lang.Double confidence)
```
    Parameters:
    
    confidence -
    
    See Also:
    
    getConfidence()
  - getOwnerUserId
```
public UserIdentity getOwnerUserId()
```
    Returns:
    
    the owner user identity
    
    See Also:
    
    setOwnerUserId(UserIdentity)
  - setOwnerUserId
```
public void setOwnerUserId(UserIdentity userId)
```
    Parameters:
    
    userId -
    
    See Also:
    
    getOwnerUserId()
  - getOwnerUserIdValue
```
public java.lang.Long getOwnerUserIdValue()
```
    Returns:
    
    owner user identity value
    
    See Also:
    
    getOwnerUserId()
  - getServiceType
```
public CAContentCore.ServiceType getServiceType()
```
    Returns:
    
    service type
    
    See Also:
    
    setServiceType(service.tut.pori.contentanalysis.CAContentCore.ServiceType)
  - setServiceType
```
public void setServiceType(CAContentCore.ServiceType serviceType)
```
    Parameters:
    
    serviceType -
    
    See Also:
    
    getServiceType()
  - getValue
```
public java.lang.String getValue()
```
    Returns:
    
    object value, can be same as name
    
    See Also:
    
    getName(), setValue(String)
  - getObjectId
```
public java.lang.String getObjectId()
```
    Generally externally generated id, unique only when used in combination with back-end id, or if back-end id is missing, with user id.
    
    Returns:
    
    non-unique creator specific object id
    
    See Also:
    
    setObjectId(String)
  - setObjectId
```
public void setObjectId(java.lang.String objectId)
```
    Parameters:
    
    objectId -
    
    See Also:
    
    getObjectId()
  - getMediaObjectId
```
public java.lang.String getMediaObjectId()
```
    Internally generated, unique Id.
    
    Returns:
    
    DB (row) id
    
    See Also:
    
    setMediaObjectId(String)
  - setMediaObjectId
```
public void setMediaObjectId(java.lang.String id)
```
    Parameters:
    
    id - DB (row) id
    
    See Also:
    
    getMediaObjectId()
  - getBackendId
```
public java.lang.Integer getBackendId()
```
    Returns:
    
    back-end id
    
    See Also:
    
    setBackendId(Integer)
  - setBackendId
```
public void setBackendId(java.lang.Integer backendId)
```
    Parameters:
    
    backendId -
    
    See Also:
    
    getBackendId()
  - getConfirmationStatus
```
public MediaObject.ConfirmationStatus getConfirmationStatus()
```
    Returns:
    
    status
    
    See Also:
    
    setConfirmationStatus(ConfirmationStatus)
  - setConfirmationStatus
```
public void setConfirmationStatus(MediaObject.ConfirmationStatus status)
```
    Parameters:
    
    status -
    
    See Also:
    
    getConfirmationStatus()
  - getConfirmationStatusValue
```
public java.lang.Integer getConfirmationStatusValue()
```
    Returns:
    
    status value
    
    See Also:
    
    getConfirmationStatus()
  - getVisualShape
```
public VisualShape getVisualShape()
```
    Returns:
    
    shape
    
    See Also:
    
    setVisualShape(VisualShape)
  - setVisualShape
```
public void setVisualShape(VisualShape shape)
```
    Parameters:
    
    shape -
    
    See Also:
    
    getVisualShape()
  - setValue
```
public void setValue(java.lang.String value)
```
    Parameters:
    
    value -
    
    See Also:
    
    getValue()
  - setMediaObjectType
```
public void setMediaObjectType(MediaObject.MediaObjectType type)
```
    Parameters:
    
    type -
    
    See Also:
    
    getMediaObjectType()
  - getMediaObjectType
```
public MediaObject.MediaObjectType getMediaObjectType()
```
    Returns:
    
    object type
    
    See Also:
    
    setMediaObjectType(MediaObjectType)
  - getMediaObjectTypeValue
```
public java.lang.Integer getMediaObjectTypeValue()
```
    Returns:
    
    object type value
    
    See Also:
    
    getMediaObjectType()
  - getServiceId
```
public java.lang.Integer getServiceId()
```
    Returns:
    
    service type id
    
    See Also:
    
    getServiceType()
  - getName
```
public java.lang.String getName()
```
    Returns:
    
    name or short description of the object
    
    See Also:
    
    setName(String)
  - setName
```
public void setName(java.lang.String name)
```
    Parameters:
    
    name -
    
    See Also:
    
    getName()
  - isValid
```
public static boolean isValid(MediaObject object)
```
    Parameters:
    
    object - can be null
    
    Returns:
    
    true if the passed object is valid
  - setVisibility
```
public void setVisibility(CAContentCore.Visibility visibility)
```
    Parameters:
    
    visibility -
    
    See Also:
    
    getVisibility()
  - getVisibility
```
public CAContentCore.Visibility getVisibility()
```
    Returns:
    
    object visibility
    
    See Also:
    
    setVisibility(service.tut.pori.contentanalysis.CAContentCore.Visibility)
  - getVisibilityValue
```
public java.lang.Integer getVisibilityValue()
```
    Returns:
    
    visibility value
    
    See Also:
    
    getVisibility()
  - getUpdated
```
public java.util.Date getUpdated()
```
    Returns:
    
    the updated
  - setUpdated
```
public void setUpdated(java.util.Date updated)
```
    Parameters:
    
    updated - the updated to set
  - setVisualShapeTypeId
```
public void setVisualShapeTypeId(java.lang.Integer type)
                          throws java.lang.IllegalArgumentException
```
    Specified by:
    
    setVisualShapeTypeId in interface VisualShape.VisualShapeSolrCapable
    
    Throws:
    
    java.lang.IllegalArgumentException - on bad type value
    
    See Also:
    
    VisualShape.VisualShapeSolrCapable.getVisualShapeTypeId()
  - getVisualShapeTypeId
```
public java.lang.Integer getVisualShapeTypeId()
```
    Specified by:
    
    getVisualShapeTypeId in interface VisualShape.VisualShapeSolrCapable
    
    Returns:
    
    shape type id
    
    See Also:
    
    VisualShape.VisualShapeSolrCapable.getVisualShapeTypeId()
  - setVisualShapeValue
```
public void setVisualShapeValue(java.lang.String value)
```
    Specified by:
    
    setVisualShapeValue in interface VisualShape.VisualShapeSolrCapable
    
    See Also:
    
    VisualShape.VisualShapeSolrCapable.getVisualShapeValue()
  - getVisualShapeValue
```
public java.lang.String getVisualShapeValue()
```
    Specified by:
    
    getVisualShapeValue in interface VisualShape.VisualShapeSolrCapable
    
    Returns:
    
    shape value
    
    See Also:
    
    VisualShape.VisualShapeSolrCapable.setVisualShapeValue(String)
  - getRank
```
public java.lang.Integer getRank()
```
    Returns:
    
    the rank
    
    See Also:
    
    setRank(Integer)
  - setRank
```
public void setRank(java.lang.Integer rank)
```
    Parameters:
    
    rank - the rank to set
    
    See Also:
    
    getRank()
  - getMediaType
```
public MediaUrlValidator.MediaType getMediaType()
```
    Returns:
    
    the mediaType
  - setMediaType
```
public void setMediaType(MediaUrlValidator.MediaType mediaType)
```
    Parameters:
    
    mediaType - the mediaType to set
  - getMediaTypeValue
```
public java.lang.Integer getMediaTypeValue()
```
    Returns:
    
    status value
    
    See Also:
    
    getMediaType()
  - getTimecodes
```
public TimecodeList getTimecodes()
```
    Returns:
    
    the timecodes
  - setSolrTimecodes
```
public void setSolrTimecodes(java.util.List<java.lang.String> timecodes)
```
    Solr serializing helper method
    
    Parameters:
    
    timecodes - the timecodes to set in SolrJ format.
  - getSolrTimecodes
```
public java.util.List<java.lang.String> getSolrTimecodes()
```
    Solr serializing helper method
    
    Returns:
    
    the SolrJ formatted list of timecodes
  - setTimecodes
```
public void setTimecodes(TimecodeList timecodes)
```
    Parameters:
    
    timecodes - the timecodes to set

Class MediaObject

Optional Elements

XML Example

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MediaObject

MediaObject

Method Detail

getConfidence

setConfidence

getOwnerUserId

setOwnerUserId

getOwnerUserIdValue

getServiceType

setServiceType

getValue

getObjectId

setObjectId

getMediaObjectId

setMediaObjectId

getBackendId

setBackendId

getConfirmationStatus

setConfirmationStatus

getConfirmationStatusValue

getVisualShape

setVisualShape

setValue

setMediaObjectType

getMediaObjectType

getMediaObjectTypeValue

getServiceId

getName

setName

isValid

setVisibility

getVisibility

getVisibilityValue

getUpdated

setUpdated

setVisualShapeTypeId

getVisualShapeTypeId

setVisualShapeValue

getVisualShapeValue

getRank

setRank

getMediaType

setMediaType

getMediaTypeValue

getTimecodes

setSolrTimecodes

getSolrTimecodes

setTimecodes