service.tut.pori.contentanalysis

Class PhotoList

java.lang.Object

core.tut.pori.http.ResponseData

service.tut.pori.contentanalysis.PhotoList

Direct Known Subclasses:

DeletedPhotoList, DissimilarPhotoList, ReferencePhotoList, SimilarPhotoList

public class PhotoList
extends ResponseData

This is a container class for photo elements, which can be used directly with Response to provide XML output.

XML Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mediaList>
  <media>
    <credits>KwGZilfORbxRYDnRJOOATeERkgKQobENXDvDyLmWWWZtwTEQXzQZUamJazFZyZfP</credits>
    <description>pLPMXalhsjkVJrXVvEytTkYQxEIZdRMhbqsYgmAwreCmHedvLJpZOsjwgcBptpfL</description>
    <UID>afc8c96c-6523-4bff-9c74-87630156b47e</UID>
    <name>pnmKDeNIVVrTTAtrNtUdCnUlZyZRODEQtbNgYLcDDDFUxYzaCcKdovSDPQoUwBKr</name>
    <serviceId>1</serviceId>
    <visibility>PUBLIC</visibility>
    <objectList>
      <object>
        <backendId>105334350</backendId>
        <confidence>0.04171823869280289</confidence>
        <mediaObjectId>7381899336412632613</mediaObjectId>
        <mediaType>PHOTO</mediaType>
        <objectId>YYaxNjxnhtaFSuJuOCJAJNtAGAthZdrDurOmWsALajqputefKTPIBwXrNlPNwHoO</objectId>
        <rank>754453812</rank>
        <serviceId>6</serviceId>
        <status>NO_FRIENDLY_KEYWORD</status>
        <objectType>KEYWORD</objectType>
        <value>OTcKUADumreJKzkcbJlDllSyqrXnxEkbxDiuQVvXbejHPJZaVZlSWoRgHbTCjCFz</value>
        <visibility>PRIVATE</visibility>
        <userId>8291827787728071338</userId>
      </object>
    </objectList>
    <mediaType>PHOTO</mediaType>
    <userId>8291827787728071338</userId>
    <url>http://fe.example.org/rest/carc/r?uid=afc8c96c-6523-4bff-9c74-87630156b47e&amp;service_id=1</url>
  </media>
</mediaList>

See Also:

Photo, ResultInfo

Constructor Summary

Constructors

Constructor and Description
PhotoList() NOTE: to use getPhotoList factory functions, the nullary constructor of the inherited class MUST be available

Method Summary

Modifier and Type	Method and Description
void	addPhoto(Photo photo)
void	addPhotos(PhotoList photos)
static int	count(PhotoList list)
java.util.List<java.lang.String>	getGUIDs()
static java.util.List<java.lang.String>	getGUIDs(PhotoList photoList)
Photo	getPhoto(java.lang.String guid)
static PhotoList	getPhotoList(java.util.Collection<Photo> photos, ResultInfo resultInfo)
java.util.List<Photo>	getPhotos()
ResultInfo	getResultInfo()
static boolean	isEmpty(PhotoList list)
static boolean	isValid(PhotoList list)
void	setPhotos(java.util.List<Photo> photos) replace the currently set set of photos with a new set of photos
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

PhotoList

public PhotoList()

NOTE: to use getPhotoList factory functions, the nullary constructor of the inherited class MUST be available

Method Detail

getPhotos

public java.util.List<Photo> getPhotos()

Returns:

list of photos

See Also:

setPhotos(List)

getGUIDs

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

Returns:

list of GUIDs in this list or null if the list contains no GUIDs.

getGUIDs

public static java.util.List<java.lang.String> getGUIDs(PhotoList photoList)

Parameters:

photoList -

Returns:

GUIDs contained in the given photo list or null if none. Photos without GUIDs will be ignored.

getResultInfo

public ResultInfo getResultInfo()

Returns:

resultInfo or null if not available

See Also:

setResultInfo(ResultInfo)

setResultInfo

public void setResultInfo(ResultInfo resultInfo)

Parameters:

resultInfo -

See Also:

getResultInfo()

setPhotos

public void setPhotos(java.util.List<Photo> photos)

replace the currently set set of photos with a new set of photos

Parameters:

photos -

See Also:

getPhotos()

addPhoto

public void addPhoto(Photo photo)

Parameters:

photo -

See Also:

getPhotos()

addPhotos

public void addPhotos(PhotoList photos)

Parameters:

photos -

See Also:

getPhotos()

getPhoto

public Photo getPhoto(java.lang.String guid)

Parameters:

guid -

Returns:

photo with the given guid or null if not in the list

getPhotoList

public static PhotoList getPhotoList(java.util.Collection<Photo> photos,
                                     ResultInfo resultInfo)

Parameters:

photos -

resultInfo - optional resultInfo

Returns:

new photo list of null if null or empty photos given

isEmpty

public static boolean isEmpty(PhotoList list)

Parameters:

list -

Returns:

true if the given list is empty or null

isValid

public static boolean isValid(PhotoList list)

Parameters:

list - can be null

Returns:

true if the given list is valid

count

public static int count(PhotoList list)

Parameters:

list -

Returns:

number of photos in the list or 0 if null or empty list passed