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.ml.timeseries.converter;
031
032import org.openimaj.ml.timeseries.TimeSeries;
033import org.openimaj.ml.timeseries.processor.TimeSeriesProcessor;
034
035/**
036 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
037 * 
038 * A time series converter goes from one type of {@link TimeSeries} to another given a processor.
039 * 
040 * @param <INPUTALL> The input all data type
041 * @param <INPUTSINGLE> the input single data type
042 * @param <INPUTTS> the input time series
043 * @param <OUTPUTALL> the output all data type
044 * @param <OUTPUTSINGLE> the output single data type
045 * @param <OUTPUTTS> the output time series type
046 */
047public interface TimeSeriesConverter<
048        INPUTALL,INPUTSINGLE,INPUTTS extends TimeSeries<INPUTALL,INPUTSINGLE,INPUTTS>,
049        OUTPUTALL,OUTPUTSINGLE,OUTPUTTS extends TimeSeries<OUTPUTALL,OUTPUTSINGLE,OUTPUTTS>
050> {
051        /**
052         * @param series convert the series
053         * @return the converted series
054         */
055        public OUTPUTTS convert(INPUTTS series);
056        
057        /**
058         * convert and process a time series
059         * @param series the input series
060         * @param processor the processor to alter the converted input
061         * @return the processed converted input
062         */
063        public OUTPUTTS convert(INPUTTS series, TimeSeriesProcessor<OUTPUTALL, OUTPUTSINGLE, OUTPUTTS> processor);
064}