Filter.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2014 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.timeline.filters;

import javafx.beans.property.SimpleBooleanProperty;
import javafx.collections.FXCollections;
import javafx.collections.ObservableList;
import org.sleuthkit.autopsy.timeline.events.type.RootEventType;

public interface Filter {

    static Filter getDefaultFilter() {
        return Filter.intersect(new Filter[]{new HideKnownFilter(), new TextFilter(), new TypeFilter(RootEventType.getInstance())});
    }

    public static IntersectionFilter intersect(ObservableList<Filter> filters) {
        return new IntersectionFilter(filters);
    }

    public static IntersectionFilter intersect(Filter[] filters) {
        return new IntersectionFilter(FXCollections.observableArrayList(filters));
    }

    Filter copyOf();

    String getDisplayName();

    String getHTMLReportString();

    String getStringCheckBox();

    boolean isActive();

    void setActive(Boolean act);

    SimpleBooleanProperty getActiveProperty();

    /* TODO: disabled state only affects the state of the checkboxes in the ui
     * and not the actual filters and shouldn't be implemented here, but it
     * was too hard to figure out how it should be implemented without intruding
     * on the ui-ignorant filters */
    void setDisabled(Boolean act);

    SimpleBooleanProperty getDisabledProperty();

    boolean isDisabled();
}