AbstractTimelineChart.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2011-2018 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.sleuthkit.autopsy.timeline.ui;

import java.util.Comparator;
import java.util.HashMap;
import java.util.Map;
import javafx.application.Platform;
import javafx.beans.binding.DoubleBinding;
import javafx.collections.FXCollections;
import javafx.collections.ListChangeListener;
import javafx.collections.ObservableList;
import javafx.collections.transformation.SortedList;
import javafx.geometry.Pos;
import javafx.scene.Node;
import javafx.scene.chart.Axis;
import javafx.scene.chart.XYChart;
import javafx.scene.control.Label;
import javafx.scene.control.OverrunStyle;
import javafx.scene.control.Tooltip;
import javafx.scene.layout.Border;
import javafx.scene.layout.BorderStroke;
import javafx.scene.layout.BorderStrokeStyle;
import javafx.scene.layout.BorderWidths;
import javafx.scene.layout.CornerRadii;
import javafx.scene.layout.HBox;
import javafx.scene.layout.Pane;
import javafx.scene.layout.Region;
import javafx.scene.layout.VBox;
import javafx.scene.paint.Color;
import javafx.scene.text.Font;
import javafx.scene.text.FontWeight;
import javafx.scene.text.Text;
import javafx.scene.text.TextAlignment;
import javax.annotation.concurrent.Immutable;
import org.apache.commons.lang3.StringUtils;
import org.openide.util.NbBundle;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.coreutils.ThreadConfined;
import org.sleuthkit.autopsy.timeline.TimeLineController;
import org.sleuthkit.datamodel.TimelineEventType;

public abstract class AbstractTimelineChart<X, Y, NodeType extends Node, ChartType extends Region & TimeLineChart<X>> extends AbstractTimeLineView {

    private static final Logger logger = Logger.getLogger(AbstractTimelineChart.class.getName());

    @NbBundle.Messages("AbstractTimelineChart.defaultTooltip.text=Drag the mouse to select a time interval to zoom into.\nRight-click for more actions.")
    private static final Tooltip DEFAULT_TOOLTIP = new Tooltip(Bundle.AbstractTimelineChart_defaultTooltip_text());
    private static final Border ONLY_LEFT_BORDER = new Border(new BorderStroke(Color.BLACK, BorderStrokeStyle.SOLID, CornerRadii.EMPTY, new BorderWidths(0, 0, 0, 1)));

    static public Tooltip getDefaultTooltip() {
        return DEFAULT_TOOLTIP;
    }

    protected ObservableList<NodeType> getSelectedNodes() {
        return selectedNodes;
    }

    protected final ObservableList<XYChart.Series<X, Y>> dataSeries = FXCollections.<XYChart.Series<X, Y>>observableArrayList();
    protected final Map<TimelineEventType, XYChart.Series<X, Y>> eventTypeToSeriesMap = new HashMap<>();

    private ChartType chart;

    private final Pane specificLabelPane = new Pane(); // container for the specfic labels in the decluttered axis
    private final Pane contextLabelPane = new Pane();// container for the contextual labels in the decluttered axis
// container for the contextual labels in the decluttered axis
    private final Region spacer = new Region();

    final private ObservableList<NodeType> selectedNodes = FXCollections.observableArrayList();

    public Pane getSpecificLabelPane() {
        return specificLabelPane;
    }

    public Pane getContextLabelPane() {
        return contextLabelPane;
    }

    public Region getSpacer() {
        return spacer;
    }

    protected ChartType getChart() {
        return chart;
    }

    @ThreadConfined(type = ThreadConfined.ThreadType.JFX)
    protected void setChart(ChartType chart) {
        this.chart = chart;
        setCenter(chart);
    }

    protected void applySelectionEffect(NodeType node) {
        applySelectionEffect(node, true);
    }

    protected void removeSelectionEffect(NodeType node) {
        applySelectionEffect(node, Boolean.FALSE);
    }

    abstract protected Boolean isTickBold(X value);

    abstract protected void applySelectionEffect(NodeType node, Boolean applied);

    abstract protected String getTickMarkLabel(X tickValue);

    abstract protected double getTickSpacing();

    abstract protected Axis<X> getXAxis();

    abstract protected Axis<Y> getYAxis();

    abstract protected double getAxisMargin();

    protected final void createSeries() {
        for (TimelineEventType eventType : getController().getEventsModel().getEventTypes()) {
            XYChart.Series<X, Y> series = new XYChart.Series<>();
            series.setName(eventType.getDisplayName());
            eventTypeToSeriesMap.put(eventType, series);
            dataSeries.add(series);
        }
    }

    protected final XYChart.Series<X, Y> getSeries(final TimelineEventType eventType) {
        return eventTypeToSeriesMap.get(eventType);
    }

    protected AbstractTimelineChart(TimeLineController controller) {
        super(controller);
        Platform.runLater(new Runnable() {
            @Override
            public void run() {
                VBox vBox = new VBox(getSpecificLabelPane(), getContextLabelPane());
                vBox.setFillWidth(false);
                HBox hBox = new HBox(getSpacer(), vBox);
                hBox.setFillHeight(false);
                setBottom(hBox);
                DoubleBinding spacerSize = getYAxis().widthProperty().add(getYAxis().tickLengthProperty()).add(getAxisMargin());
                getSpacer().minWidthProperty().bind(spacerSize);
                getSpacer().prefWidthProperty().bind(spacerSize);
                getSpacer().maxWidthProperty().bind(spacerSize);
            }
        });

        createSeries();

        selectedNodes.addListener((ListChangeListener.Change<? extends NodeType> change) -> {
            while (change.next()) {
                change.getRemoved().forEach(node -> applySelectionEffect(node, false));
                change.getAddedSubList().forEach(node -> applySelectionEffect(node, true));
            }
        });

        //show tooltip text in status bar
        hoverProperty().addListener(hoverProp -> controller.setStatusMessage(isHover() ? getDefaultTooltip().getText() : ""));

    }

    @ThreadConfined(type = ThreadConfined.ThreadType.JFX)
    protected synchronized void layoutDateLabels() {
        //clear old labels
        contextLabelPane.getChildren().clear();
        specificLabelPane.getChildren().clear();
        //since the tickmarks aren't necessarily in value/position order,
        //make a copy of the list sorted by position along axis
        SortedList<Axis.TickMark<X>> tickMarks = getXAxis().getTickMarks().sorted(Comparator.comparing(Axis.TickMark::getPosition));

        if (tickMarks.isEmpty()) {
            /*
             * Since StackedBarChart does some funky animation/background thread
             * stuff, sometimes there are no tick marks even though there is
             * data. Dispatching another call to layoutDateLables() allows that
             * stuff time to run before we check a gain.
             */
            Platform.runLater(this::layoutDateLabels);
        } else {
            //get the spacing between ticks in the underlying axis
            double spacing = getTickSpacing();

            //initialize values from first tick
            TwoPartDateTime dateTime = new TwoPartDateTime(getTickMarkLabel(tickMarks.get(0).getValue()));
            String lastSeenContextLabel = dateTime.context;

            //x-positions (pixels) of the current branch and leaf labels
            double specificLabelX = 0;

            if (dateTime.context.isEmpty()) {
                //if there is only one part to the date (ie only year), just add a label for each tick
                for (Axis.TickMark<X> t : tickMarks) {
                    addSpecificLabel(new TwoPartDateTime(getTickMarkLabel(t.getValue())).specifics,
                            spacing,
                            specificLabelX,
                            isTickBold(t.getValue())
                    );
                    specificLabelX += spacing;  //increment x
                }
            } else {
                //there are two parts so ...
                //initialize additional state
                double contextLabelX = 0;
                double contextLabelWidth = 0;

                for (Axis.TickMark<X> t : tickMarks) {
                    //split the label into a TwoPartDateTime
                    dateTime = new TwoPartDateTime(getTickMarkLabel(t.getValue()));

                    //if we are still in the same context
                    if (lastSeenContextLabel.equals(dateTime.context)) {
                        //increment context width
                        contextLabelWidth += spacing;
                    } else {// we are on to a new context, so ...
                        addContextLabel(lastSeenContextLabel, contextLabelWidth, contextLabelX);
                        //and then update label, x-pos, and width
                        lastSeenContextLabel = dateTime.context;
                        contextLabelX += contextLabelWidth;
                        contextLabelWidth = spacing;
                    }
                    //add the specific label (highest frequency part)
                    addSpecificLabel(dateTime.specifics, spacing, specificLabelX, isTickBold(t.getValue()));

                    //increment specific position
                    specificLabelX += spacing;
                }
                //we have reached end so add label for current context
                addContextLabel(lastSeenContextLabel, contextLabelWidth, contextLabelX);
            }
        }
        //request layout since we have modified scene graph structure
        requestParentLayout();
    }

    private synchronized void addSpecificLabel(String labelText, double labelWidth, double labelX, boolean bold) {
        Text label = new Text(" " + labelText + " "); //NON-NLS
        label.setTextAlignment(TextAlignment.CENTER);
        label.setFont(Font.font(null, bold ? FontWeight.BOLD : FontWeight.NORMAL, 10));
        //position label accounting for width
        label.relocate(labelX + labelWidth / 2 - label.getBoundsInLocal().getWidth() / 2, 0);
        label.autosize();

        if (specificLabelPane.getChildren().isEmpty()) {
            //just add first label
            specificLabelPane.getChildren().add(label);
        } else {
            //otherwise don't actually add the label if it would intersect with previous label

            final Node lastLabel = specificLabelPane.getChildren().get(specificLabelPane.getChildren().size() - 1);

            if (false == lastLabel.getBoundsInParent().intersects(label.getBoundsInParent())) {
                specificLabelPane.getChildren().add(label);
            }
        }
    }

    private synchronized void addContextLabel(String labelText, double labelWidth, double labelX) {
        Label label = new Label(labelText);
        label.setAlignment(Pos.CENTER);
        label.setTextAlignment(TextAlignment.CENTER);
        label.setFont(Font.font(10));
        //use a leading ellipse since that is the lowest frequency part,
        //and can be infered more easily from other surrounding labels
        label.setTextOverrun(OverrunStyle.LEADING_ELLIPSIS);
        //force size
        label.setMinWidth(labelWidth);
        label.setPrefWidth(labelWidth);
        label.setMaxWidth(labelWidth);
        label.relocate(labelX, 0);

        if (labelX == 0) { // first label has no border
            label.setBorder(null);
        } else {  // subsequent labels have border on left to create dividers
            label.setBorder(ONLY_LEFT_BORDER);
        }

        contextLabelPane.getChildren().add(label);
    }

    @Immutable
    private static final class TwoPartDateTime {

        private final String context;

        private final String specifics;

        TwoPartDateTime(String dateString) {
            //find index of separator to split on
            int splitIndex = StringUtils.lastIndexOfAny(dateString, " ", "-", ":"); //NON-NLS
            if (splitIndex < 0) { // there is only one part
                specifics = dateString;
                context = ""; //NON-NLS
            } else { //split at index
                specifics = StringUtils.substring(dateString, splitIndex + 1);
                context = StringUtils.substring(dateString, 0, splitIndex);
            }
        }
    }

}