org.openimaj.tools.imagecollection.collection

Interface ImageCollection<ImageType extends Image<?,ImageType>>

Type Parameters:

ImageType -

All Superinterfaces:

Iterable<ImageCollectionEntry<ImageType>>

All Known Implementing Classes:

AbstractWebpageImageCollection, AbstractWebpageImageCollection.Generic, FlickrWebpageImageCollection, FlickrWebpageImageCollection.FlickrPhotoCollection, FlickrWebpageImageCollection.FlickrPhotoSet, FlickrWebpageImageCollection.Gallery, XuggleVideoImageCollection, XuggleVideoImageCollection.FromFile, XuggleVideoImageCollection.FromURL, YouTubeVideoImageCollection

public interface ImageCollection<ImageType extends Image<?,ImageType>>
extends Iterable<ImageCollectionEntry<ImageType>>

An image collection knows how to load itself from a given type of configuration. Image collections are iterable and they can also give all their stored images at once

Author:

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

Method Summary

Modifier and Type	Method and Description
int	countImages()
ImageCollectionConfig	defaultConfig(String rawInput) If possible, will return a default configuration using the raw input
List<ImageCollectionEntry<ImageType>>	getAll()
void	setEntrySelection(ImageCollectionEntrySelection<ImageType> selection) Control how an image collection is to accept or ignore a given entry of the collection
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 interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

setup

void setup(ImageCollectionConfig config)
    throws ImageCollectionSetupException

Setup this collection using the provided collection config.

Parameters:

config -

Throws:

ImageCollectionSetupException

useable

int useable(ImageCollectionConfig config)

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

Parameters:

config -

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

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.

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

ImageCollectionConfig defaultConfig(String rawInput)

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

getAll

List<ImageCollectionEntry<ImageType>> getAll()

Returns:

List of all images in this collection

countImages

int countImages()

Returns:

The number of images in this collection (might be an estimate or 0, don't rely on this)

setEntrySelection

void setEntrySelection(ImageCollectionEntrySelection<ImageType> selection)

Control how an image collection is to accept or ignore a given entry of the collection

Parameters:

selection -