com.metsci.glimpse.layers.time.TimelineView Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of glimpse-layers Show documentation
The newest version!
/*
 * Copyright (c) 2020, Metron, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Metron, Inc. nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL METRON, INC. BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.metsci.glimpse.layers.time;

import static com.jogamp.opengl.GLProfile.GL3;
import static com.metsci.glimpse.core.painter.info.SimpleTextPainter.HorizontalPosition.Right;
import static com.metsci.glimpse.docking.DockingUtils.requireIcon;
import static com.metsci.glimpse.layers.time.TimeTrait.requireTimeTrait;
import static com.metsci.glimpse.layers.time.TimeZoneTrait.requireTimeZoneTrait;
import static com.metsci.glimpse.util.PredicateUtils.notNull;

import java.time.ZoneId;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.TimeZone;
import java.util.function.Consumer;

import javax.swing.Icon;

import com.google.common.collect.ImmutableSet;
import com.jogamp.opengl.GLProfile;
import com.metsci.glimpse.core.axis.painter.label.AxisUnitConverter;
import com.metsci.glimpse.core.axis.painter.label.AxisUnitConverters;
import com.metsci.glimpse.core.axis.tagged.TaggedAxisMouseListener1D;
import com.metsci.glimpse.core.context.GlimpseContext;
import com.metsci.glimpse.core.painter.decoration.GridPainter;
import com.metsci.glimpse.core.painter.info.SimpleTextPainter;
import com.metsci.glimpse.core.plot.timeline.CollapsibleTimePlot2D;
import com.metsci.glimpse.core.plot.timeline.event.EventPlotInfo;
import com.metsci.glimpse.core.plot.timeline.layout.TimePlotInfo;
import com.metsci.glimpse.core.support.font.FontUtils;
import com.metsci.glimpse.layers.GlimpseCanvasView;
import com.metsci.glimpse.layers.ViewOption;
import com.metsci.glimpse.util.var.Var;

public class TimelineView extends GlimpseCanvasView
{

    protected CollapsibleTimePlot2D plot;
    protected Var timeZone;

    protected Map rowRefCounts;


    public TimelineView( ViewOption... viewOptions )
    {
        this( ImmutableSet.copyOf( viewOptions ) );
    }

    public TimelineView( Collection viewOptions )
    {
        super( GLProfile.get( GL3 ), viewOptions );

        this.title.set( "Timeline" );

        this.plot = null;
        this.timeZone = null;
        this.rowRefCounts = null;
    }

    @Override
    public Icon getIcon( )
    {
        return requireIcon( TimelineView.class.getResource( "icons/openicon/time.png" ) );
    }

    @Override
    protected void doContextReady( GlimpseContext context )
    {
        this.plot = new CollapsibleTimePlot2D( );
        this.plot.setTimeAxisMouseListener( new TaggedAxisMouseListener1D( ) );
        this.plot.setShowLabels( true );

        this.timeZone = new Var<>( ZoneId.of( "UTC" ), notNull );
        this.timeZone.addListener( true, ( ) ->
        {
            TimeZone tz = TimeZone.getTimeZone( this.timeZone.v( ) );
            this.plot.getTimeAxisLabelHandler( ).setTimeZone( tz );
            this.plot.getDefaultTimeline( ).setTimeZone( tz );
        } );

        this.rowRefCounts = new HashMap<>( );

        this.canvas.addLayout( this.plot );
    }

    @Override
    public void doInit( )
    {
        TimeTrait timeTrait = requireTimeTrait( this );
        this.plot.setEpoch( timeTrait.epoch );
        this.plot.getTimeAxis( ).setParent( timeTrait.axis );

        TimeZoneTrait timeZoneTrait = requireTimeZoneTrait( this );
        this.timeZone.setParent( timeZoneTrait.timeZone );
    }

    @Override
    protected void doContextDying( GlimpseContext context )
    {
        this.canvas.removeLayout( this.plot );

        this.timeZone.setParent( null );
        this.plot.dispose( context );

        this.plot = null;
        this.timeZone = null;
        this.rowRefCounts = null;
    }

    @Override
    public TimelineView copy( )
    {
        return new TimelineView( this.viewOptions );
    }

    public EventPlotInfo acquireEventRow( Object rowId, String labelText )
    {
        EventPlotInfo row = this.plot.getEventPlot( rowId );
        if ( row == null )
        {
            row = this.plot.createEventPlot( rowId );

            row.setGrow( false );

            GridPainter gridPainter = row.getGridPainter( );
            gridPainter.setShowVerticalLines( true );
            gridPainter.setShowHorizontalLines( false );
            gridPainter.setVisible( true );
            row.getLayout( ).setZOrder( gridPainter, -1 );

            SimpleTextPainter labelPainter = row.getLabelPainter( );
            labelPainter.setHorizontalLabels( true );
            labelPainter.setFont( FontUtils.getDefaultBold( 12 ), true );

            row.setFont( FontUtils.getDefaultPlain( 12 ), true );
            row.setLabelText( labelText );
        }

        this.rowRefCounts.compute( rowId, ( k, v ) -> incRefCount( v ) );

        return row;
    }

    public TimePlotInfo acquirePlotRow( Object rowId, String dataAxisText )
    {
        return this.acquirePlotRow( rowId, dataAxisText, AxisUnitConverters.identity );
    }

    public TimePlotInfo acquirePlotRow( Object rowId, String dataAxisText, AxisUnitConverter dataAxisUnits )
    {
        return this.acquirePlotRow( rowId, dataAxisText, AxisUnitConverters.identity, null );
    }

    public TimePlotInfo acquirePlotRow( Object rowId, String dataAxisText, AxisUnitConverter dataAxisUnits, Consumer initFn )
    {
        TimePlotInfo row = this.plot.getTimePlot( rowId );
        if ( row == null )
        {
            row = this.plot.createTimePlot( rowId );

            GridPainter gridPainter = row.getGridPainter( );
            gridPainter.setShowVerticalLines( true );
            gridPainter.setShowHorizontalLines( false );
            gridPainter.setVisible( true );
            row.getLayout( ).setZOrder( gridPainter, -1 );

            SimpleTextPainter labelPainter = row.getLabelPainter( );
            labelPainter.setText( dataAxisText );
            labelPainter.setHorizontalLabels( false );
            labelPainter.setHorizontalPadding( 9 );
            labelPainter.setHorizontalPosition( Right );
            labelPainter.setFont( FontUtils.getDefaultPlain( 12 ), true );

            row.getAxisPainter( ).getLabelHandlerY( ).setAxisUnitConverter( dataAxisUnits );

            if ( initFn != null )
            {
                initFn.accept( row );
            }
        }

        this.rowRefCounts.compute( rowId, ( k, v ) -> incRefCount( v ) );

        return row;
    }

    public void releaseRow( Object rowId )
    {
        this.releaseRow( rowId, false );
    }

    public void releaseRow( Object rowId, boolean keepRow )
    {
        Integer refCount = this.rowRefCounts.compute( rowId, ( k, v ) -> decRefCount( v ) );

        if ( refCount == null && !keepRow )
        {
            this.plot.removePlot( rowId );
        }
    }

    public static Integer incRefCount( Integer refCount )
    {
        return ( refCount == null ? 1 : refCount + 1 );
    }

    public static Integer decRefCount( Integer refCount )
    {
        return ( refCount >= 2 ? refCount - 1 : null );
    }

}