KeywordSearchJobSettings.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.keywordsearch;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import org.sleuthkit.autopsy.ingest.IngestModuleIngestJobSettings;

public final class KeywordSearchJobSettings implements IngestModuleIngestJobSettings {

    private static final long serialVersionUID = 1L;
    private static final boolean DEFAULT_INDEX_TO_SOLR = true;
    
    private final HashSet<String> namesOfEnabledKeywordLists;
    private HashSet<String> namesOfDisabledKeywordLists; // Added in version 1.1

    private Boolean ocrEnabled;
    private Boolean limitedOCREnabled;

    private boolean ocrOnly;
    
    // use object boolean so older settings missing this setting will deserialize to null.
    private Boolean indexToSolr;

    KeywordSearchJobSettings(List<String> namesOfEnabledKeywordLists) {
        this.namesOfEnabledKeywordLists = new HashSet<>(namesOfEnabledKeywordLists);
        this.namesOfDisabledKeywordLists = new HashSet<>();
        
        // explicitly set to default value
        this.ocrEnabled = null;
        this.limitedOCREnabled = null;
        this.ocrOnly = false;
        this.indexToSolr = true;
    }

    KeywordSearchJobSettings(List<String> namesOfEnabledKeywordLists, List<String> namesOfDisabledKeywordLists, boolean ocrEnabled, boolean limitedOCREnabled, boolean ocrOnly, boolean indexToSolr) {
        this.namesOfEnabledKeywordLists = new HashSet<>(namesOfEnabledKeywordLists);
        this.namesOfDisabledKeywordLists = new HashSet<>(namesOfDisabledKeywordLists);
        this.ocrEnabled = ocrEnabled;
        this.limitedOCREnabled = limitedOCREnabled;
        this.ocrOnly = ocrOnly;
        this.indexToSolr = indexToSolr;
    }

    @SuppressWarnings("deprecation")
    public boolean isOCREnabled() {
        if (ocrEnabled == null) {
            ocrEnabled = KeywordSearchSettings.getOcrOption();
        }
        
        return ocrEnabled;
    }

    public void setOCREnabled(boolean ocrEnabled) {
        this.ocrEnabled = ocrEnabled;
    }

    @SuppressWarnings("deprecation")
    boolean isLimitedOCREnabled() {
        if (limitedOCREnabled == null) {
            limitedOCREnabled = KeywordSearchSettings.getLimitedOcrOption();
        }
        
        return limitedOCREnabled;
    }

    void setLimitedOCREnabled(boolean limitedOCREnabled) {
        this.limitedOCREnabled = limitedOCREnabled;
    }

    boolean isOCROnly() {
        return ocrOnly;
    }

    void setOCROnly(boolean ocrOnly) {
        this.ocrOnly = ocrOnly;
    }

    @Override
    public long getVersionNumber() {
        this.upgradeFromOlderVersions();
        return serialVersionUID;
    }

    boolean keywordListIsEnabled(String keywordListName) {
        this.upgradeFromOlderVersions();
        return namesOfEnabledKeywordLists.contains(keywordListName);
    }

    List<String> getNamesOfEnabledKeyWordLists() {
        this.upgradeFromOlderVersions();
        return new ArrayList<>(namesOfEnabledKeywordLists);
    }

    List<String> getNamesOfDisabledKeyWordLists() {
        this.upgradeFromOlderVersions();
        return new ArrayList<>(namesOfDisabledKeywordLists);
    }

    private void upgradeFromOlderVersions() {
        if (null == this.namesOfDisabledKeywordLists) {
            this.namesOfDisabledKeywordLists = new HashSet<>();
        }
    }
    
    boolean isIndexToSolrEnabled() {
        return indexToSolr == null ? DEFAULT_INDEX_TO_SOLR : indexToSolr;
    }
    
    void setIndexToSolrEnabled(boolean enabled){
        indexToSolr = enabled;
    }

}