org.openimaj.web.scraping.images

Class ImgurClient

java.lang.Object

org.openimaj.web.scraping.images.ImgurClient

public class ImgurClient
extends Object

An imgur client has the various functionality of the imgur.com api

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImgurClient.ImageResponse An image response is composed of two Maps, one describing the image and another describing its links
static class	ImgurClient.ImgurType
static class	ImgurClient.ImgurTypeHash The type and hash usually returned from imgurURLtoHash(URL)

Constructor Summary

Constructors

Constructor and Description
ImgurClient()

Method Summary

Modifier and Type	Method and Description
List<ImgurClient.ImageResponse>	getAlbumImages(String hash) Calls http://api.imgur.com/2/album/:ID
List<ImgurClient.ImageResponse>	getGalleryImages() Calls http://imgur.com/gallery.json
List<ImgurClient.ImageResponse>	getImages(ImgurClient.ImgurTypeHash typehash) Depending on the ImgurClient.ImgurTypeHash instance calls getSingleImage(String), getAlbumImages(String) or getGalleryImages()
ImgurClient.ImageResponse	getSingleImage(String hash) Calls http://api.imgur.com/2/image/:HASH
static ImgurClient.ImgurTypeHash	imgurURLtoHash(URL url)

Methods inherited from class java.lang.Object

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

Constructor Detail

ImgurClient

public ImgurClient()

Method Detail

getImages

public List<ImgurClient.ImageResponse> getImages(ImgurClient.ImgurTypeHash typehash)
                                          throws org.apache.http.client.ClientProtocolException,
                                                 IOException

Depending on the ImgurClient.ImgurTypeHash instance calls getSingleImage(String), getAlbumImages(String) or getGalleryImages()

Parameters:

typehash -

Returns:

a list of ImgurClient.ImageResponse instances

Throws:

IOException

org.apache.http.client.ClientProtocolException

getSingleImage

public ImgurClient.ImageResponse getSingleImage(String hash)
                                         throws org.apache.http.client.ClientProtocolException,
                                                IOException

Calls http://api.imgur.com/2/image/:HASH

Parameters:

hash -

Returns:

the json response

Throws:

IOException

org.apache.http.client.ClientProtocolException

getAlbumImages

public List<ImgurClient.ImageResponse> getAlbumImages(String hash)
                                               throws org.apache.http.client.ClientProtocolException,
                                                      IOException

Calls http://api.imgur.com/2/album/:ID

Parameters:

hash -

Returns:

the json response

Throws:

IOException

org.apache.http.client.ClientProtocolException

getGalleryImages

public List<ImgurClient.ImageResponse> getGalleryImages()

Calls http://imgur.com/gallery.json

Returns:

the json response

imgurURLtoHash

public static ImgurClient.ImgurTypeHash imgurURLtoHash(URL url)

Parameters:

url -

Returns:

the imgur type and hash, or null if the URL was too tricky