AbstractLoadableComponent.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 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.datasourcesummary.uiutils;

import java.util.Collection;
import java.util.logging.Level;
import javax.swing.JPanel;
import org.openide.util.NbBundle;
import org.sleuthkit.autopsy.coreutils.Logger;

@NbBundle.Messages({
    "AbstractLoadableComponent_loadingMessage_defaultText=Loading results...",
    "AbstractLoadableComponent_errorMessage_defaultText=There was an error loading results.",
    "AbstractLoadableComponent_noDataExists_defaultText=No data exists.",})
public abstract class AbstractLoadableComponent<T> extends JPanel implements LoadableComponent<T> {

    private static final long serialVersionUID = 1L;
    
    public static final String DEFAULT_LOADING_MESSAGE = Bundle.AbstractLoadableComponent_loadingMessage_defaultText();

    public static final String DEFAULT_ERROR_MESSAGE = Bundle.AbstractLoadableComponent_errorMessage_defaultText();

    public static final String DEFAULT_NO_RESULTS_MESSAGE = Bundle.AbstractLoadableComponent_noDataExists_defaultText();

    private static final Logger logger = Logger.getLogger(AbstractLoadableComponent.class.getName());

    public static String getDefaultErrorMessage() {
        return DEFAULT_ERROR_MESSAGE;
    }

    public static String getDefaultNoResultsMessage() {
        return DEFAULT_NO_RESULTS_MESSAGE;
    }

    public synchronized void showMessage(String message) {
        setResults(null);
        setMessage(true, message);
        repaint();
    }

    public void showDefaultLoadingMessage() {
        showMessage(DEFAULT_LOADING_MESSAGE);
    }

    public synchronized void showResults(T data) {
        setMessage(false, null);
        setResults(data);
        repaint();
    }

    public void showDataFetchResult(DataFetchResult<T> result, String errorMessage, String noResultsMessage) {
        if (result == null) {
            logger.log(Level.SEVERE, "Null data fetch result received.");
            return;
        }

        switch (result.getResultType()) {
            case SUCCESS:
                T data = result.getData();
                if (data == null || (data instanceof Collection<?> && ((Collection<?>) data).isEmpty())) {
                    showMessage(noResultsMessage);
                } else {
                    showResults(data);
                }
                break;
            case ERROR:
                // if there is an error, log accordingly, set result list to 
                // empty and display error message
                logger.log(Level.WARNING, "An exception was caused while results were loaded.", result.getException());
                showMessage(errorMessage);
                break;
            default:
                // an unknown loading state was specified.  log accordingly.
                logger.log(Level.SEVERE, "No known loading state was found in result.");
                break;
        }
    }

    public void showDataFetchResult(DataFetchResult<T> result) {
        showDataFetchResult(result, DEFAULT_ERROR_MESSAGE, DEFAULT_NO_RESULTS_MESSAGE);
    }

    protected abstract void setMessage(boolean visible, String message);

    protected abstract void setResults(T data);
}