ObjectDetectedFilterPanel.java

Go to the documentation of this file.

/*
 * Autopsy
 *
 * Copyright 2020-2021 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.ui;

import java.util.ArrayList;
import org.sleuthkit.autopsy.discovery.search.AbstractFilter;
import java.util.List;
import java.util.logging.Level;
import javax.swing.JCheckBox;
import javax.swing.JLabel;
import javax.swing.event.ListSelectionListener;
import org.openide.util.NbBundle;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.coreutils.ThreadConfined;
import org.sleuthkit.autopsy.discovery.search.SearchFiltering;
import org.sleuthkit.datamodel.BlackboardArtifact;
import org.sleuthkit.datamodel.BlackboardAttribute;
import org.sleuthkit.datamodel.TskCoreException;

final class ObjectDetectedFilterPanel extends AbstractDiscoveryFilterPanel {

    private static final long serialVersionUID = 1L;
    private final static Logger logger = Logger.getLogger(ObjectDetectedFilterPanel.class.getName());

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    ObjectDetectedFilterPanel() {
        initComponents();
        setUpObjectFilter();
        add(objectsList);
    }

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    private void setUpObjectFilter() {
        try {
            objectsList.clearList();
            List<String> setNames = DiscoveryUiUtils.getSetNames(BlackboardArtifact.ARTIFACT_TYPE.TSK_OBJECT_DETECTED, BlackboardAttribute.ATTRIBUTE_TYPE.TSK_DESCRIPTION);
            for (String name : setNames) {
                objectsList.addElement(name, null, name);
            }
        } catch (TskCoreException ex) {
            logger.log(Level.SEVERE, "Error loading object detected set names", ex);
            objectsCheckbox.setEnabled(false);
            objectsList.setEnabled(false);
        }
    }

    @SuppressWarnings("unchecked")
    // <editor-fold defaultstate="collapsed" desc="Generated Code">//GEN-BEGIN:initComponents
    private void initComponents() {

        objectsCheckbox = new javax.swing.JCheckBox();
        objectsList = new org.sleuthkit.autopsy.guiutils.CheckBoxListPanel<>();

        org.openide.awt.Mnemonics.setLocalizedText(objectsCheckbox, org.openide.util.NbBundle.getMessage(ObjectDetectedFilterPanel.class, "ObjectDetectedFilterPanel.text")); // NOI18N
        objectsCheckbox.setMaximumSize(new java.awt.Dimension(150, 25));
        objectsCheckbox.setMinimumSize(new java.awt.Dimension(150, 25));
        objectsCheckbox.setName(""); // NOI18N
        objectsCheckbox.setPreferredSize(new java.awt.Dimension(150, 25));
        objectsCheckbox.setVerticalAlignment(javax.swing.SwingConstants.TOP);
        objectsCheckbox.setVerticalTextPosition(javax.swing.SwingConstants.TOP);
        objectsCheckbox.addActionListener(new java.awt.event.ActionListener() {
            public void actionPerformed(java.awt.event.ActionEvent evt) {
                objectsCheckboxActionPerformed(evt);
            }
        });

        setMinimumSize(new java.awt.Dimension(250, 30));
        setPreferredSize(new java.awt.Dimension(250, 30));
        setLayout(new java.awt.BorderLayout());
        add(objectsList, java.awt.BorderLayout.CENTER);
    }// </editor-fold>//GEN-END:initComponents

    private void objectsCheckboxActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_objectsCheckboxActionPerformed
        objectsList.setEnabled(objectsCheckbox.isSelected());
    }//GEN-LAST:event_objectsCheckboxActionPerformed


    // Variables declaration - do not modify//GEN-BEGIN:variables
    private javax.swing.JCheckBox objectsCheckbox;
    private org.sleuthkit.autopsy.guiutils.CheckBoxListPanel<String> objectsList;
    // End of variables declaration//GEN-END:variables

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    @Override
    void configurePanel(boolean selected, List<?> selectedItems) {
        boolean hasObjects = isFilterSupported();
        objectsCheckbox.setEnabled(hasObjects);
        objectsCheckbox.setSelected(selected && hasObjects);
        if (objectsCheckbox.isEnabled() && objectsCheckbox.isSelected()) {
            objectsList.setEnabled(true);
            if (selectedItems != null) {
                List<String> objectList = new ArrayList<>();
                for (Object item : selectedItems) {
                    if (item instanceof String) {
                        objectList.add((String) item);
                    }
                }
                if (!objectList.isEmpty()) {
                    objectsList.setSelectedElements(objectList);
                }
            }
        } else {
            objectsList.setEnabled(false);
        }
    }

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    @Override
    JCheckBox getCheckbox() {
        return objectsCheckbox;
    }

    @Override
    JLabel getAdditionalLabel() {
        return null;
    }

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    @NbBundle.Messages({"ObjectDetectedFilterPanel.error.text=At least one object type name must be selected."})
    @Override
    String checkForError() {
        if (objectsCheckbox.isSelected() && objectsList.getSelectedElements().isEmpty()) {
            return Bundle.ObjectDetectedFilterPanel_error_text();
        }
        return "";
    }

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    @Override
    AbstractFilter getFilter() {
        if (objectsCheckbox.isSelected()) {
            List<String> objectDetectedList = objectsList.getSelectedElements();
            return new SearchFiltering.ObjectDetectionFilter(objectDetectedList);
        }
        return null;
    }
    
    @Override
    void addListSelectionListener(ListSelectionListener listener) {
        objectsList.addListSelectionListener(listener);
    }
    
    @Override
    boolean isFilterSupported() {
        return !objectsList.isEmpty();
    }

}