DiscoveryEventUtils.java

Go to the documentation of this file.

/*
 * Autopsy
 *
 * Copyright 2019-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;

import com.google.common.eventbus.EventBus;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import org.sleuthkit.autopsy.discovery.FileSearch.GroupKey;
import org.sleuthkit.autopsy.discovery.FileSearchData.FileType;
import org.sleuthkit.datamodel.AbstractFile;

final class DiscoveryEventUtils {

    private final static EventBus discoveryEventBus = new EventBus();

    static EventBus getDiscoveryEventBus() {
        return discoveryEventBus;
    }

    private DiscoveryEventUtils() {
        //Utility class private constructor intentionally left blank.
    }

    static final class SearchStartedEvent {

        private final FileType fileType;

        SearchStartedEvent(FileType type) {
            this.fileType = type;
        }

        FileType getType() {
            return fileType;
        }
    }

    static final class ClearInstanceSelectionEvent {

        ClearInstanceSelectionEvent() {
            //no arg constructor
        }
    }

    static final class PopulateInstancesListEvent {

        private final List<AbstractFile> instances;

        PopulateInstancesListEvent(List<AbstractFile> files) {
            instances = files;
        }

        List<AbstractFile> getInstances() {
            return Collections.unmodifiableList(instances);
        }
    }

    static final class SearchCompleteEvent {

        private final Map<GroupKey, Integer> groupMap;
        private final List<FileSearchFiltering.FileFilter> searchFilters;
        private final FileSearch.AttributeType groupingAttribute;
        private final FileGroup.GroupSortingAlgorithm groupSort;
        private final FileSorter.SortingMethod fileSortMethod;

        SearchCompleteEvent(Map<GroupKey, Integer> groupMap, List<FileSearchFiltering.FileFilter> searchfilters,
                FileSearch.AttributeType groupingAttribute, FileGroup.GroupSortingAlgorithm groupSort,
                FileSorter.SortingMethod fileSortMethod) {
            this.groupMap = groupMap;
            this.searchFilters = searchfilters;
            this.groupingAttribute = groupingAttribute;
            this.groupSort = groupSort;
            this.fileSortMethod = fileSortMethod;
        }

        Map<GroupKey, Integer> getGroupMap() {
            return Collections.unmodifiableMap(groupMap);
        }

        List<FileSearchFiltering.FileFilter> getFilters() {
            return Collections.unmodifiableList(searchFilters);
        }

        FileSearch.AttributeType getGroupingAttr() {
            return groupingAttribute;
        }

        FileGroup.GroupSortingAlgorithm getGroupSort() {
            return groupSort;
        }

        FileSorter.SortingMethod getFileSort() {
            return fileSortMethod;
        }

    }

    static final class PageRetrievedEvent {

        private final List<ResultFile> results;
        private final int page;
        private final FileType resultType;

        PageRetrievedEvent(FileType resultType, int page, List<ResultFile> results) {
            this.results = results;
            this.page = page;
            this.resultType = resultType;
        }

        List<ResultFile> getSearchResults() {
            return Collections.unmodifiableList(results);
        }

        int getPageNumber() {
            return page;
        }

        FileType getType() {
            return resultType;
        }
    }

    static final class NoResultsEvent {

        NoResultsEvent() {
            //no arg constructor
        }
    }

    static final class SearchCancelledEvent {

        SearchCancelledEvent() {
            //no arg constructor
        }

    }

    static final class GroupSelectedEvent {

        private final FileType resultType;
        private final GroupKey groupKey;
        private final int groupSize;
        private final List<FileSearchFiltering.FileFilter> searchfilters;
        private final FileSearch.AttributeType groupingAttribute;
        private final FileGroup.GroupSortingAlgorithm groupSort;
        private final FileSorter.SortingMethod fileSortMethod;

        GroupSelectedEvent(List<FileSearchFiltering.FileFilter> searchfilters,
                FileSearch.AttributeType groupingAttribute, FileGroup.GroupSortingAlgorithm groupSort,
                FileSorter.SortingMethod fileSortMethod, GroupKey groupKey, int groupSize, FileType resultType) {
            this.searchfilters = searchfilters;
            this.groupingAttribute = groupingAttribute;
            this.groupSort = groupSort;
            this.fileSortMethod = fileSortMethod;
            this.groupKey = groupKey;
            this.groupSize = groupSize;
            this.resultType = resultType;
        }

        FileType getResultType() {
            return resultType;
        }

        GroupKey getGroupKey() {
            return groupKey;
        }

        int getGroupSize() {
            return groupSize;
        }

        FileGroup.GroupSortingAlgorithm getGroupSort() {
            return groupSort;
        }

        FileSorter.SortingMethod getFileSort() {
            return fileSortMethod;
        }

        List<FileSearchFiltering.FileFilter> getFilters() {
            return Collections.unmodifiableList(searchfilters);
        }

        FileSearch.AttributeType getGroupingAttr() {
            return groupingAttribute;
        }

    }

    static class DetailsVisibleEvent {

        private final boolean showDetailsArea;

        DetailsVisibleEvent(boolean isVisible) {
            showDetailsArea = isVisible;
        }

        boolean isShowDetailsArea() {
            return showDetailsArea;
        }
    }

}