TimelineEvent.java

Go to the documentation of this file.

/*
 * Sleuth Kit Data Model
 *
 * 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.datamodel;

import java.util.Optional;

public final class TimelineEvent {

        private final long eventID;

        private final long contentObjID;

        private final Long artifactID;

        private final long dataSourceObjID;

        private final long time;

        private final TimelineEventType type;

        private final TimelineEventDescription descriptions;

        private final boolean eventSourceHashHitDetected;

        private final boolean eventSourceTagged;

        TimelineEvent(long eventID,
                        long dataSourceObjID,
                        long contentObjID,
                        Long artifactID,
                        long time,
                        TimelineEventType type,
                        String fullDescription,
                        String medDescription,
                        String shortDescription,
                        boolean eventSourceHashHitDetected,
                        boolean eventSourceTagged) {
                this.eventID = eventID;
                this.dataSourceObjID = dataSourceObjID;
                this.contentObjID = contentObjID;
                this.artifactID = Long.valueOf(0).equals(artifactID) ? null : artifactID;
                this.time = time;
                this.type = type;
                /*
                 * The cast that follows reflects the fact that we have not decided
                 * whether or not to add the parseDescription method to the
                 * TimelineEventType interface yet. Currently (9/18/19), this method is
                 * part of TimelineEventTypeImpl and all implementations of
                 * TimelineEventType are subclasses of TimelineEventTypeImpl.
                 */
                if (type instanceof TimelineEventTypeImpl) {
                        this.descriptions = ((TimelineEventTypeImpl) type).parseDescription(fullDescription, medDescription, shortDescription);
                } else {
                        this.descriptions = new TimelineEventDescription(fullDescription, medDescription, shortDescription);
                }
                this.eventSourceHashHitDetected = eventSourceHashHitDetected;
                this.eventSourceTagged = eventSourceTagged;
        }

        public boolean eventSourceIsTagged() {
                return eventSourceTagged;
        }

        public boolean eventSourceHasHashHits() {
                return eventSourceHashHitDetected;
        }

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

        public long getEventID() {
                return eventID;
        }

        public long getContentObjID() {
                return contentObjID;
        }

        public long getTime() {
                return time;
        }

        public TimelineEventType getEventType() {
                return type;
        }

        public String getDescription(TimelineLevelOfDetail levelOfDetail) {
                return descriptions.getDescription(levelOfDetail);
        }

        public long getDataSourceObjID() {
                return dataSourceObjID;
        }

        public long getEventTimeInMs() {
                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 TimelineEvent other = (TimelineEvent) obj;
                return this.eventID == other.getEventID();
        }

}