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.clusterquantiser;
031
032import java.io.File;
033import java.io.IOException;
034import java.io.InputStream;
035import java.util.Iterator;
036
037import org.openimaj.feature.local.LocalFeature;
038import org.openimaj.feature.local.list.FileLocalFeatureList;
039import org.openimaj.feature.local.list.LocalFeatureList;
040import org.openimaj.feature.local.list.StreamLocalFeatureList;
041import org.openimaj.image.feature.local.keypoints.Keypoint;
042
043/**
044 * A {@link FeatureFile} backed by a stream or file. Doesn't require the list be
045 * held in memory.
046 * 
047 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
048 */
049public class StreamedFeatureFile extends FeatureFile {
050
051        private LocalFeatureList<? extends LocalFeature<?, ?>> kpl;
052        private Class<? extends Iterator<FeatureFileFeature>> iteratorType;
053
054        /**
055         * Default constructor
056         */
057        public StreamedFeatureFile() {
058                this.iteratorType = KeypointListArrayIterator.class;
059        }
060
061        /**
062         * Construct with list
063         * 
064         * @param kpl
065         */
066        public StreamedFeatureFile(LocalFeatureList<? extends LocalFeature<?, ?>> kpl) {
067                this();
068                this.kpl = kpl;
069        }
070
071        /**
072         * Construct with file
073         * 
074         * @param keypointFile
075         * @param clz
076         * @throws IOException
077         */
078        public StreamedFeatureFile(File keypointFile, Class<? extends Keypoint> clz) throws IOException {
079                this();
080                this.kpl = FileLocalFeatureList.read(keypointFile, clz);
081        }
082
083        /**
084         * Construct with file
085         * 
086         * @param keypointFile
087         * @throws IOException
088         */
089        public StreamedFeatureFile(File keypointFile) throws IOException {
090
091                this(keypointFile, Keypoint.class);
092        }
093
094        /**
095         * Construct with stream
096         * 
097         * @param stream
098         * @throws IOException
099         */
100        public StreamedFeatureFile(InputStream stream) throws IOException {
101                this();
102                this.kpl = StreamLocalFeatureList.read(stream, Keypoint.class);
103        }
104
105        /**
106         * Construct with stream
107         * 
108         * @param stream
109         * @param clz
110         * @throws IOException
111         */
112        public StreamedFeatureFile(InputStream stream, Class<? extends Keypoint> clz) throws IOException {
113                this();
114                this.kpl = StreamLocalFeatureList.read(stream, clz);
115        }
116
117        /**
118         * Set the iterator type
119         * 
120         * @param cls
121         */
122        public void setIteratorType(Class<? extends Iterator<FeatureFileFeature>> cls) {
123                this.iteratorType = cls;
124        }
125
126        @Override
127        public Iterator<FeatureFileFeature> iterator() {
128                try {
129                        return this.iteratorType.getConstructor(LocalFeatureList.class).newInstance(kpl);
130                } catch (final Exception e) {
131                        e.printStackTrace();
132                }
133                return null;
134        }
135
136        @Override
137        public int size() {
138                return kpl.size();
139        }
140
141        @Override
142        public FeatureFileFeature get(int index) {
143                int done = 0;
144                for (final FeatureFileFeature fff : this) {
145                        if (done++ == index)
146                                return fff;
147                }
148                return null;
149        }
150
151        @Override
152        public void close() {
153        }
154}