Result.java

Go to the documentation of this file.

/*
 * Autopsy
 *
 * Copyright 2020 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.discovery.search;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import org.sleuthkit.datamodel.Content;
import org.sleuthkit.datamodel.TskCoreException;
import org.sleuthkit.datamodel.TskData;

public abstract class Result {

    private SearchData.Frequency frequency = SearchData.Frequency.UNKNOWN;
    private SearchData.PreviouslyNotable notabilityStatus = SearchData.PreviouslyNotable.NOT_PREVIOUSLY_NOTABLE;
    private final List<String> tagNames = new ArrayList<>();

    public abstract long getDataSourceObjectId();

    public SearchData.Frequency getFrequency() {
        return frequency;
    }

    public abstract TskData.FileKnown getKnown();
    
    final public void markAsPreviouslyNotableInCR() {
        this.notabilityStatus = SearchData.PreviouslyNotable.PREVIOUSLY_NOTABLE;
    }
    
    final public SearchData.PreviouslyNotable getPreviouslyNotableInCR() {
        return this.notabilityStatus;
    }

    final public void setFrequency(SearchData.Frequency frequency) {
        this.frequency = frequency;
    }

    public abstract Content getDataSource() throws TskCoreException;

    public abstract SearchData.Type getType();

    public void addTagName(String tagName) {
        if (!tagNames.contains(tagName)) {
            tagNames.add(tagName);
        }

        // Sort the list so the getTagNames() will be consistent regardless of the order added
        Collections.sort(tagNames);
    }

    public List<String> getTagNames() {
        return Collections.unmodifiableList(tagNames);
    }
}