EventsTreeItem.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2014-18 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.detailview.tree;

import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.Optional;
import javafx.scene.control.TreeItem;
import org.sleuthkit.autopsy.coreutils.ThreadConfined;
import org.sleuthkit.autopsy.timeline.ui.detailview.datamodel.DetailViewEvent;
import org.sleuthkit.autopsy.timeline.ui.detailview.datamodel.EventStripe;
import org.sleuthkit.datamodel.TimelineEventType;

abstract class EventsTreeItem extends TreeItem<DetailViewEvent> {

    private Comparator<TreeItem<DetailViewEvent>> comparator;

    EventsTreeItem(Comparator<TreeItem<DetailViewEvent>> comparator) {
        this.comparator = comparator;
    }

    public Comparator<TreeItem<DetailViewEvent>> getComparator() {
        return comparator;
    }

    final protected void setComparator(Comparator<TreeItem<DetailViewEvent>> comparator) {
        this.comparator = comparator;
    }

    abstract void sort(Comparator<TreeItem<DetailViewEvent>> comparator, Boolean recursive);

    public EventsTreeItem findTreeItemForEvent(DetailViewEvent event) {
        for (TreeItem<DetailViewEvent> child : getChildren()) {
            final EventsTreeItem findTreeItemForEvent = ((EventsTreeItem) child).findTreeItemForEvent(event);
            if (findTreeItemForEvent != null) {
                return findTreeItemForEvent;
            }
        }
        return null;
    }

    abstract String getDisplayText();

    abstract TimelineEventType getEventType();

    @ThreadConfined(type = ThreadConfined.ThreadType.JFX)
    abstract void remove(List<DetailViewEvent> path);

    @ThreadConfined(type = ThreadConfined.ThreadType.JFX)
    abstract void insert(List<DetailViewEvent> path);

    static List<DetailViewEvent> getTreePath(DetailViewEvent event) {
        List<DetailViewEvent> path = new ArrayList<>();
        path.add(0, event);
        Optional<EventStripe> parentOptional = event.getParentStripe();
        while (parentOptional.isPresent()) {
            EventStripe parent = parentOptional.get();
            path.add(0, parent);
            parentOptional = parent.getParentStripe();
        }
        return path;
    }

    <T extends EventsTreeItem> T configureNewTreeItem(T newTreeItem) {
        getChildren().add(newTreeItem);
        newTreeItem.setExpanded(true);
        sort(getComparator(), false);
        return newTreeItem;
    }
}