EventStripe.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2018-2019 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.datamodel;

import com.google.common.base.Preconditions;
import com.google.common.collect.Sets;
import static java.util.Collections.singleton;
import static java.util.Comparator.comparing;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.SortedSet;
import org.sleuthkit.datamodel.TimelineLevelOfDetail;
import org.sleuthkit.datamodel.TimelineEventType;

public final class EventStripe implements MultiEvent<EventCluster> {

    private final EventCluster parent;

    private final SortedSet<EventCluster> clusters;

    private final TimelineEventType type;

    private final String description;

    private final TimelineLevelOfDetail lod;

    private final Set<Long> eventIDs;

    private final Set<Long> tagged;

    private final Set<Long> hashHits;

    public static EventStripe merge(EventStripe stripeA, EventStripe stripeB) {
        Preconditions.checkNotNull(stripeA);
        Preconditions.checkNotNull(stripeB);
        Preconditions.checkArgument(Objects.equals(stripeA.description, stripeB.description));
        Preconditions.checkArgument(Objects.equals(stripeA.lod, stripeB.lod));
        Preconditions.checkArgument(Objects.equals(stripeA.type, stripeB.type));
        Preconditions.checkArgument(Objects.equals(stripeA.parent, stripeB.parent));
        return new EventStripe(stripeA, stripeB);
    }

    public EventStripe withParent(EventCluster parent) {
        if (Objects.nonNull(this.parent)) {
            throw new IllegalStateException("Event Stripe already has a parent!");
        }
        return new EventStripe(parent, this.type, this.description, this.lod, clusters, eventIDs, tagged, hashHits);
    }

    private EventStripe(EventCluster parent, TimelineEventType type, String description,
                        TimelineLevelOfDetail lod, SortedSet<EventCluster> clusters,
                        Set<Long> eventIDs, Set<Long> tagged, Set<Long> hashHits) {
        this.parent = parent;
        this.type = type;
        this.description = description;
        this.lod = lod;
        this.clusters = clusters;

        this.eventIDs = eventIDs;
        this.tagged = tagged;
        this.hashHits = hashHits;
    }

    public EventStripe(EventCluster cluster) {
        this.clusters = DetailsViewModel.copyAsSortedSet(singleton(cluster.withParent(this)),
                comparing(EventCluster::getStartMillis));

        type = cluster.getEventType();
        description = cluster.getDescription();
        lod = cluster.getDescriptionLevel();
        eventIDs = cluster.getEventIDs();
        tagged = cluster.getEventIDsWithTags();
        hashHits = cluster.getEventIDsWithHashHits();
        this.parent = null;
    }

    private EventStripe(EventStripe stripeA, EventStripe stripeB) {
        clusters = DetailsViewModel.copyAsSortedSet(Sets.union(stripeA.getClusters(), stripeB.getClusters()), comparing(EventCluster::getStartMillis));

        type = stripeA.getEventType();
        description = stripeA.getDescription();
        lod = stripeA.getDescriptionLevel();
        eventIDs = Sets.union(stripeA.getEventIDs(), stripeB.getEventIDs());
        tagged = Sets.union(stripeA.getEventIDsWithTags(), stripeB.getEventIDsWithTags());
        hashHits = Sets.union(stripeA.getEventIDsWithHashHits(), stripeB.getEventIDsWithHashHits());
        parent = stripeA.getParent().orElse(stripeB.getParent().orElse(null));
    }

    @Override
    public Optional<EventCluster> getParent() {
        return Optional.ofNullable(parent);
    }

    @Override
    public Optional<EventStripe> getParentStripe() {
        if (getParent().isPresent()) {
            return getParent().get().getParent();
        } else {
            return Optional.empty();
        }
    }

    @Override
    public String getDescription() {
        return description;
    }

    @Override
    public TimelineEventType getEventType() {
        return type;
    }

    @Override
    public TimelineLevelOfDetail getDescriptionLevel() {
        return lod;
    }

    @Override
    public Set<Long> getEventIDs() {
        return eventIDs;
    }

    @Override
    public Set<Long> getEventIDsWithHashHits() {
        return hashHits;
    }

    @Override
    public Set<Long> getEventIDsWithTags() {
        return tagged;
    }

    @Override
    public long getStartMillis() {
        return clusters.first().getStartMillis();
    }

    @Override
    public long getEndMillis() {
        return clusters.last().getEndMillis();
    }

    @Override
    public SortedSet< EventCluster> getClusters() {
        return clusters;
    }

    @Override
    public String toString() {
        return "EventStripe{" + "description=" + description + ", eventIDs=" + (Objects.isNull(eventIDs) ? 0 : eventIDs.size()) + '}'; //NON-NLS
    }

    @Override
    public int hashCode() {
        int hash = 3;
        hash = 79 * hash + Objects.hashCode(this.clusters);
        hash = 79 * hash + Objects.hashCode(this.type);
        hash = 79 * hash + Objects.hashCode(this.description);
        hash = 79 * hash + Objects.hashCode(this.lod);
        hash = 79 * hash + Objects.hashCode(this.eventIDs);
        return hash;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final EventStripe other = (EventStripe) obj;
        if (!Objects.equals(this.description, other.description)) {
            return false;
        }
        if (!Objects.equals(this.clusters, other.clusters)) {
            return false;
        }
        if (!Objects.equals(this.type, other.type)) {
            return false;
        }
        if (this.lod != other.lod) {
            return false;
        }
        return Objects.equals(this.eventIDs, other.eventIDs);
    }

}