001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.tools.imagecollection.collection;
031
032import java.util.List;
033import org.openimaj.image.Image;
034import org.openimaj.tools.imagecollection.collection.config.ImageCollectionConfig;
035
036/**
037 * An image collection knows how to load itself from a given type of configuration. 
038 * Image collections are iterable and they can also give all their stored images at once
039 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
040 *
041 * @param <ImageType>
042 */
043public interface ImageCollection<ImageType extends Image<?,ImageType>> extends Iterable<ImageCollectionEntry<ImageType>>{
044        /**
045         * Setup this collection using the provided collection config.
046         * @param config
047         * @throws ImageCollectionSetupException 
048         */
049        public void setup(ImageCollectionConfig config) throws ImageCollectionSetupException;
050        /**
051         * Is the contents of the provided image colleciton config sufficient for this collection to run. 
052         * 
053         * @param config
054         * @return < 0 if this collection is not useable with this configuration. >= 0 otherwise, higher numbers 
055         * give a clue as to ability to deal with configuration when compared to other collections
056         */
057        public int useable(ImageCollectionConfig config);
058        
059        /**
060         * Given a raw string which might define a URL, file location or whatever, can this collection construct a default configuration
061         * which works.
062         * 
063         * @param rawInput string
064         * @return < 0 if this collection is not useable with this configuration. >= 0 otherwise, higher numbers 
065         * give a clue as to ability to deal with configuration when compared to other collections
066         */
067        public int useable(String rawInput);
068        
069        /**
070         * If possible, will return a default configuration using the raw input
071         * 
072         * @param rawInput string
073         * @return a default configuration, might be null if the raw input is not useable
074         */
075        public ImageCollectionConfig defaultConfig(String rawInput);
076        
077        /**
078         * @return List of all images in this collection
079         */
080        public List<ImageCollectionEntry<ImageType>> getAll();
081        
082        /**
083         * @return The number of images in this collection (might be an estimate or 0, don't rely on this)
084         */
085        public int countImages();
086        
087        /**
088         * Control how an image collection is to accept or ignore a given entry of the collection
089         * @param selection
090         */
091        public void setEntrySelection(ImageCollectionEntrySelection<ImageType> selection);
092        
093}