SingleDetailsViewEvent.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.collect.ImmutableMap;
import com.google.common.collect.ImmutableSortedSet;
import java.util.Collections;
import java.util.Comparator;
import java.util.Optional;
import java.util.Set;
import java.util.SortedSet;
import org.joda.time.Interval;
import org.sleuthkit.datamodel.TimelineEvent;
import org.sleuthkit.datamodel.TimelineEventType;

public class SingleDetailsViewEvent implements DetailViewEvent {

    private final long eventID;
    private final long fileObjId;

    private final Long artifactID;

    private final long dataSourceObjId;

    private final long time;
    private final TimelineEventType type;

    private final ImmutableMap<TimelineEvent.DescriptionLevel, String> descriptions;

    private final boolean hashHit;

    private final boolean tagged;

    private MultiEvent<?> parent = null;

    public SingleDetailsViewEvent(long eventID, long dataSourceObjId, long fileObjId, Long artifactID, long time, TimelineEventType type, String fullDescription, String medDescription, String shortDescription, boolean hashHit, boolean tagged) {
        this.eventID = eventID;
        this.dataSourceObjId = dataSourceObjId;
        this.fileObjId = fileObjId;
        this.artifactID = Long.valueOf(0).equals(artifactID) ? null : artifactID;
        this.time = time;
        this.type = type;
        descriptions = ImmutableMap.<TimelineEvent.DescriptionLevel, String>of(TimelineEvent.DescriptionLevel.FULL, fullDescription,
                TimelineEvent.DescriptionLevel.MEDIUM, medDescription,
                TimelineEvent.DescriptionLevel.SHORT, shortDescription);
        this.hashHit = hashHit;
        this.tagged = tagged;
    }

    public SingleDetailsViewEvent(TimelineEvent singleEvent) {
        this(singleEvent.getEventID(),
                singleEvent.getDataSourceObjID(),
                singleEvent.getFileObjID(),
                singleEvent.getArtifactID().orElse(null),
                singleEvent.getTime(),
                singleEvent.getEventType(),
                singleEvent.getFullDescription(),
                singleEvent.getMedDescription(),
                singleEvent.getShortDescription(),
                singleEvent.isHashHit(),
                singleEvent.isTagged());
    }

    public SingleDetailsViewEvent withParent(MultiEvent<?> newParent) {
        SingleDetailsViewEvent singleEvent = new SingleDetailsViewEvent(eventID, dataSourceObjId, fileObjId, artifactID, time, type, descriptions.get(TimelineEvent.DescriptionLevel.FULL), descriptions.get(TimelineEvent.DescriptionLevel.MEDIUM), descriptions.get(TimelineEvent.DescriptionLevel.SHORT), hashHit, tagged);
        singleEvent.parent = newParent;
        return singleEvent;
    }

    public boolean isTagged() {
        return tagged;
    }

    public boolean isHashHit() {
        return hashHit;
    }

    public Optional<Long> getArtifactID() {
        return Optional.ofNullable(artifactID);
    }

    public long getEventID() {
        return eventID;
    }

    public long getFileID() {
        return fileObjId;
    }

    public long getTime() {
        return time;
    }

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

    public String getFullDescription() {
        return getDescription(TimelineEvent.DescriptionLevel.FULL);
    }

    public String getMedDescription() {
        return getDescription(TimelineEvent.DescriptionLevel.MEDIUM);
    }

    public String getShortDescription() {
        return getDescription(TimelineEvent.DescriptionLevel.SHORT);
    }

    public String getDescription(TimelineEvent.DescriptionLevel lod) {
        return descriptions.get(lod);
    }

    public long getDataSourceObjID() {
        return dataSourceObjId;
    }

    @Override
    public Set<Long> getEventIDs() {
        return Collections.singleton(eventID);
    }

    @Override
    public Set<Long> getEventIDsWithHashHits() {
        return isHashHit() ? Collections.singleton(eventID) : Collections.emptySet();
    }

    @Override
    public Set<Long> getEventIDsWithTags() {
        return isTagged() ? Collections.singleton(eventID) : Collections.emptySet();
    }

    @Override
    public long getEndMillis() {
        return time * 1000;
    }

    @Override
    public long getStartMillis() {
        return time * 1000;
    }

    @Override
    public int hashCode() {
        int hash = 7;
        hash = 13 * hash + (int) (this.eventID ^ (this.eventID >>> 32));
        return hash;
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final SingleDetailsViewEvent other = (SingleDetailsViewEvent) obj;
        return this.eventID == other.eventID;
    }

    @Override
    public SortedSet<EventCluster> getClusters() {
        EventCluster eventCluster = new EventCluster(new Interval(time * 1000, time * 1000), type, getEventIDs(), getEventIDsWithHashHits(), getEventIDsWithTags(), getFullDescription(), TimelineEvent.DescriptionLevel.FULL);
        return ImmutableSortedSet.orderedBy(Comparator.comparing(EventCluster::getStartMillis)).add(eventCluster).build();
    }

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

    @Override
    public TimelineEvent.DescriptionLevel getDescriptionLevel() {
        return TimelineEvent.DescriptionLevel.FULL;
    }

    @Override
    public Optional<EventStripe> getParentStripe() {
        if (parent == null) {
            return Optional.empty();
        } else if (parent instanceof EventStripe) {
            return Optional.of((EventStripe) parent);
        } else {
            return parent.getParentStripe();
        }
    }
}