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 */
030/**
031 *
032 */
033package org.openimaj.vis.timeline;
034
035import org.openimaj.vis.DataUnitsTransformer;
036import org.openimaj.vis.VisualisationImpl;
037
038/**
039 *      A timeline object is a temporal object and is able to drawn sections
040 *      of temporal data into a given viewport.  As this class also extends {@link VisualisationImpl}, the
041 *      implementation of {@link VisualisationImpl#update()} should use those dimensions
042 *      and time series to draw into the <code>visImage</code> member.
043 *
044 *      @author David Dupplaw (dpd@ecs.soton.ac.uk)
045 *  @created 3 Jul 2012
046 *      @version $Author$, $Revision$, $Date$
047 *      @param <T> The type of the data the timeline is displaying
048 */
049public abstract class TimelineObjectAdapter<T> extends VisualisationImpl<T>
050        implements TimelineObject
051{
052        /** */
053        private static final long serialVersionUID = 1L;
054
055        /** The start time */
056        protected long startTime = 0;
057
058        /** The end time */
059        protected long endTime = 0;
060
061        /** The pixel transformer to use */
062        protected DataUnitsTransformer<Float[], double[], int[]> pixelTransformer = null;
063
064        /**
065         *      Default constructor. Note that it generates a visualisation image
066         *      for visualisation of the timeline object as a stand-alone visualisation.
067         *      The size of this image is fixed to 1000x300.
068         */
069        public TimelineObjectAdapter()
070        {
071                super( 1000, 300 );
072        }
073
074        /**
075         *      {@inheritDoc}
076         *      @see org.openimaj.vis.timeline.TimelineObject#getStartTimeMilliseconds()
077         */
078        @Override
079        public long getStartTimeMilliseconds()
080        {
081                return this.startTime;
082        }
083
084        /**
085         *      {@inheritDoc}
086         *      @see org.openimaj.vis.timeline.TimelineObject#setStartTimeMilliseconds(long)
087         */
088        @Override
089        public void setStartTimeMilliseconds( final long l )
090        {
091                this.startTime = l;
092        }
093
094        /**
095         *      {@inheritDoc}
096         *      @see org.openimaj.vis.timeline.TimelineObject#getEndTimeMilliseconds()
097         */
098        @Override
099        public long getEndTimeMilliseconds()
100        {
101                return this.endTime;
102        }
103
104        /**
105         *      {@inheritDoc}
106         *      @see org.openimaj.vis.timeline.TimelineObject#setDataPixelTransformer(org.openimaj.vis.DataUnitsTransformer)
107         */
108        @Override
109        public void setDataPixelTransformer( final DataUnitsTransformer<Float[],double[],int[]> dpt )
110        {
111                this.pixelTransformer = dpt;
112        }
113}