service.tut.pori.contentanalysis

Class MediaObjectList

java.lang.Object

core.tut.pori.http.ResponseData

service.tut.pori.contentanalysis.MediaObjectList

public class MediaObjectList
extends ResponseData

A list of media objects, which can be directly used as a data for XML response.

XML Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<objectList>
  <object>
    <backendId>22200878</backendId>
    <confidence>0.09512127523092495</confidence>
    <mediaObjectId>9210176875192639934</mediaObjectId>
    <mediaType>PHOTO</mediaType>
    <objectId>epmYdqmEBSGrkUcPpLULsxFkEnXxSdWAGhYMtXCXZLSxrzEeQPAndGTgnYlIMCBY</objectId>
    <rank>137692118</rank>
    <serviceId>4</serviceId>
    <status>CANDIDATE</status>
    <objectType>KEYWORD</objectType>
    <value>nvRETdSITOrtlnxSXOrCrAKEfjPsIGqTXHujCRyVFmoUbKfRIPqFcQwoZMvMTBqX</value>
    <visibility>GROUP</visibility>
    <userId>7428430399435218888</userId>
  </object>
</objectList>

See Also:

MediaObject

Constructor Summary

Constructors

Constructor and Description
MediaObjectList()

Method Summary

Modifier and Type	Method and Description
void	addMediaObject(MediaObject mediaObject) Note: calling this method will clear the list's result info if any is present
void	addMediaObjects(MediaObjectList mediaObjects) add the media object list to this media object list, empty list is ignored Note: calling this method will clear the list's result info if any is present
MediaObject	getMediaObject(java.lang.String mediaObjectId)
java.util.List<java.lang.String>	getMediaObjectIds()
static MediaObjectList	getMediaObjectList(java.util.List<? extends MediaObject> objects, ResultInfo resultInfo)
static MediaObjectList	getMediaObjectListFromKeywords(java.util.List<java.lang.String> keywords) Parse given keywords given in following format:
java.util.List<MediaObject>	getMediaObjects()
ResultInfo	getResultInfo() Default data groups: result_info
static boolean	isEmpty(MediaObjectList list)
static boolean	isValid(MediaObjectList list)
void	setResultInfo(ResultInfo resultInfo)

Methods inherited from class core.tut.pori.http.ResponseData

getDataClasses

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaObjectList

public MediaObjectList()

Method Detail

getMediaObjects

public java.util.List<MediaObject> getMediaObjects()

Returns:

list of photos

See Also:

addMediaObject(MediaObject), addMediaObjects(MediaObjectList)

addMediaObject

public void addMediaObject(MediaObject mediaObject)

Note: calling this method will clear the list's result info if any is present

Parameters:

mediaObject -

See Also:

getMediaObjects()

addMediaObjects

public void addMediaObjects(MediaObjectList mediaObjects)

add the media object list to this media object list, empty list is ignored Note: calling this method will clear the list's result info if any is present

Parameters:

mediaObjects -

See Also:

getMediaObjects()

getMediaObject

public MediaObject getMediaObject(java.lang.String mediaObjectId)

Parameters:

mediaObjectId - non-null id

Returns:

the media object or null if not found

getMediaObjectIds

public java.util.List<java.lang.String> getMediaObjectIds()

Returns:

list of media object ids for this list or null if none

isEmpty

public static boolean isEmpty(MediaObjectList list)

Parameters:

list -

Returns:

true if this list contains no objects, or the list is null

getMediaObjectList

public static MediaObjectList getMediaObjectList(java.util.List<? extends MediaObject> objects,
                                                 ResultInfo resultInfo)

Parameters:

objects -

resultInfo -

Returns:

list or null if null or empty list is passed

getMediaObjectListFromKeywords

public static MediaObjectList getMediaObjectListFromKeywords(java.util.List<java.lang.String> keywords)

Parse given keywords given in following format:

keyword:confidence:backendId,keyword:confidence:backendId,...

keyword is required, confidence and backendId are optional.

Parameters:

keywords -

Returns:

list of media objects based on the keywords or null if none was found

isValid

public static boolean isValid(MediaObjectList list)

Parameters:

list - can be null

Returns:

true if the passed list is valid

getResultInfo

public ResultInfo getResultInfo()

Default data groups: result_info

Returns:

the resultInfo

See Also:

setResultInfo(ResultInfo)

setResultInfo

public void setResultInfo(ResultInfo resultInfo)

Parameters:

resultInfo - the resultInfo to set

See Also:

getResultInfo()