org.openimaj.tools.imagecollection.collection.webpage

Class FlickrWebpageImageCollection

java.lang.Object

org.openimaj.tools.imagecollection.collection.webpage.AbstractWebpageImageCollection

org.openimaj.tools.imagecollection.collection.webpage.FlickrWebpageImageCollection

All Implemented Interfaces:

Iterable<ImageCollectionEntry<MBFImage>>, ImageCollection<MBFImage>

Direct Known Subclasses:

FlickrWebpageImageCollection.FlickrPhotoCollection, FlickrWebpageImageCollection.FlickrPhotoSet, FlickrWebpageImageCollection.Gallery

public abstract class FlickrWebpageImageCollection
extends AbstractWebpageImageCollection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlickrWebpageImageCollection.FlickrPhotoCollection
static class	FlickrWebpageImageCollection.FlickrPhotoSet
static class	FlickrWebpageImageCollection.Gallery

Nested classes/interfaces inherited from class org.openimaj.tools.imagecollection.collection.webpage.AbstractWebpageImageCollection

AbstractWebpageImageCollection.Generic

Field Summary

Fields

Modifier and Type	Field and Description
protected com.flickr4java.flickr.Flickr	flickr

Constructor Summary

Constructors

Constructor and Description
FlickrWebpageImageCollection()

Method Summary

Modifier and Type	Method and Description
ImageCollectionConfig	defaultConfig(String rawInput) If possible, will return a default configuration using the raw input
protected abstract com.flickr4java.flickr.photos.PhotoList<com.flickr4java.flickr.photos.Photo>	flickrProcess(String string)
abstract int	flickrUseable(String path)
Set<IndependentPair<URL,Map<String,String>>>	prepareURLs(URL url)
void	setup(ImageCollectionConfig config) Setup this collection using the provided collection config.
int	useable(ImageCollectionConfig config) Is the contents of the provided image colleciton config sufficient for this collection to run.
int	useable(String rawInput) Given a raw string which might define a URL, file location or whatever, can this collection construct a default configuration which works.

Methods inherited from class org.openimaj.tools.imagecollection.collection.webpage.AbstractWebpageImageCollection

countImages, getAll, iterator, setEntrySelection

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

flickr

protected com.flickr4java.flickr.Flickr flickr

Constructor Detail

FlickrWebpageImageCollection

public FlickrWebpageImageCollection()

Method Detail

setup

public void setup(ImageCollectionConfig config)
           throws ImageCollectionSetupException

Description copied from interface: ImageCollection

Setup this collection using the provided collection config.

Specified by:

setup in interface ImageCollection<MBFImage>

Overrides:

setup in class AbstractWebpageImageCollection

Throws:

ImageCollectionSetupException

prepareURLs

public Set<IndependentPair<URL,Map<String,String>>> prepareURLs(URL url)
                                                         throws ImageCollectionSetupException

Specified by:

prepareURLs in class AbstractWebpageImageCollection

Throws:

ImageCollectionSetupException

flickrProcess

protected abstract com.flickr4java.flickr.photos.PhotoList<com.flickr4java.flickr.photos.Photo> flickrProcess(String string)

useable

public int useable(ImageCollectionConfig config)

Description copied from interface: ImageCollection

Is the contents of the provided image colleciton config sufficient for this collection to run.

Specified by:

useable in interface ImageCollection<MBFImage>

Overrides:

useable in class AbstractWebpageImageCollection

Returns:

< 0 if this collection is not useable with this configuration. >= 0 otherwise, higher numbers give a clue as to ability to deal with configuration when compared to other collections

useable

public int useable(String rawInput)

Description copied from interface: ImageCollection

Given a raw string which might define a URL, file location or whatever, can this collection construct a default configuration which works.

Parameters:

rawInput - string

Returns:

< 0 if this collection is not useable with this configuration. >= 0 otherwise, higher numbers give a clue as to ability to deal with configuration when compared to other collections

defaultConfig

public ImageCollectionConfig defaultConfig(String rawInput)

Description copied from interface: ImageCollection

If possible, will return a default configuration using the raw input

Parameters:

rawInput - string

Returns:

a default configuration, might be null if the raw input is not useable

flickrUseable

public abstract int flickrUseable(String path)