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.data.dataset.cache;
031
032import java.util.Collection;
033
034import org.openimaj.data.dataset.GroupedDataset;
035import org.openimaj.data.dataset.ListDataset;
036
037/**
038 * Definition of a cache for groups of lists.
039 * 
040 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
041 * 
042 * @param <OBJECT>
043 *            Type of instances
044 * @param <KEY>
045 *            Type of groups
046 */
047public interface GroupedListCache<KEY, OBJECT> {
048        /**
049         * Add an object with many keys to the cache
050         * 
051         * @param keys
052         *            the instance's keys
053         * @param object
054         *            the instance
055         */
056        public void add(Collection<KEY> keys, OBJECT object);
057
058        /**
059         * Add an object with a key to the cache
060         * 
061         * @param key
062         *            the instance's key
063         * @param object
064         *            the instance
065         */
066        public void add(KEY key, OBJECT object);
067
068        /**
069         * Add an collection of objects with the same key to the cache
070         * 
071         * @param key
072         *            the instance's key
073         * @param objects
074         *            the instances
075         */
076        public void add(KEY key, Collection<OBJECT> objects);
077
078        /**
079         * @return a dataset view of the cache
080         */
081        public GroupedDataset<KEY, ListDataset<OBJECT>, OBJECT> getDataset();
082
083        /**
084         * Reset the cache
085         */
086        public void reset();
087}