org.openimaj.web.flickr

Class FlickrImage

java.lang.Object

org.openimaj.web.flickr.FlickrImage

public class FlickrImage
extends Object

A wrapper for Flickr images, and their URLs and what not. This is different to using the Photo class from com.aetrion as it specifically does not require access to Flickr and will not attempt to get any information from Flickr itself (except the image through the getImage() method). It's just a placeholder for any information known about a Flickr image.

Version:

$Author$, $Revision$, $Date$

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

12 Aug 2013

Field Summary

Fields

Modifier and Type	Field and Description
static String	sizeSuffixes The allowable size suffixes

Constructor Summary

Constructors

Constructor and Description
FlickrImage(long id, int farm, int server, String secret, char size, String extension)

Method Summary

Modifier and Type	Method and Description
static FlickrImage	create(URL url) Parses a Flickr URL and updates this object.
int	getFarm()
long	getId()
MBFImage	getImage() Reads the actual flickr image.
File	getLocalFile()
String	getSecret()
int	getServer()
char	getSize()
URI	getUrl()
boolean	isOriginal()
void	setFarm(int farm)
void	setId(long id)
void	setLocalFile(File localFile)
void	setOriginal(boolean isOriginal)
void	setSecret(String secret)
void	setServer(int server)
void	setSize(char size)
void	setUrl(URI url)

Methods inherited from class java.lang.Object

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

Field Detail

sizeSuffixes

public static final String sizeSuffixes

The allowable size suffixes

See Also:

Constant Field Values

Constructor Detail

FlickrImage

public FlickrImage(long id,
                   int farm,
                   int server,
                   String secret,
                   char size,
                   String extension)

Parameters:

id -

farm -

server -

secret -

size -

extension -

Method Detail

create

public static FlickrImage create(URL url)

Parses a Flickr URL and updates this object.

Parameters:

url - The URL

Returns:

The new FlickrImage instance

getId

public long getId()

Returns:

the id

setId

public void setId(long id)

Parameters:

id - the id to set

getUrl

public URI getUrl()

Returns:

the url

setUrl

public void setUrl(URI url)

Parameters:

url - the url to set

getFarm

public int getFarm()

Returns:

the farm

setFarm

public void setFarm(int farm)

Parameters:

farm - the farm to set

getServer

public int getServer()

Returns:

the server

setServer

public void setServer(int server)

Parameters:

server - the server to set

getSecret

public String getSecret()

Returns:

the secret

setSecret

public void setSecret(String secret)

Parameters:

secret - the secret to set

getSize

public char getSize()

Returns:

the size

setSize

public void setSize(char size)

Parameters:

size - the size to set

isOriginal

public boolean isOriginal()

Returns:

the isOriginal

setOriginal

public void setOriginal(boolean isOriginal)

Parameters:

isOriginal - the isOriginal to set

getLocalFile

public File getLocalFile()

Returns:

the localFile

setLocalFile

public void setLocalFile(File localFile)

Parameters:

localFile - the localFile to set

getImage

public MBFImage getImage()
                  throws IOException

Reads the actual flickr image. If it's cached then it will read the cache, otherwise it will contact Flickr.

Returns:

The image

Throws:

IOException