Keyword.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2011-2018 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.text.Normalizer;
import org.openide.util.NbBundle;
import org.sleuthkit.datamodel.BlackboardAttribute;

public class Keyword {

    private String searchTerm;
    private boolean isLiteral;
    private boolean isWholeWord;
    private BlackboardAttribute.ATTRIBUTE_TYPE artifactAtrributeType;
    private final String listName;
    /*
     * For substring searches, original search term (e.g. "pass" or "enger") can
     * be different from the search term (e.g. "passenger") that is found and
     * used (e.g. for highlighting purposes).
     */
    private final String originalTerm;

    Keyword(String searchTerm, boolean isLiteral, boolean isWholeWord) {
        this(searchTerm, isLiteral, isWholeWord, "", searchTerm);
    }

    Keyword(String searchTerm, boolean isLiteral, boolean isWholeWord, String listName, String originalTerm) {
        this.searchTerm = Normalizer.normalize(searchTerm, Normalizer.Form.NFKC);
        this.isLiteral = isLiteral;
        this.isWholeWord = isWholeWord;
        this.listName = listName;
        this.originalTerm = originalTerm;
        
    }

    Keyword(String searchTerm, boolean isLiteral, BlackboardAttribute.ATTRIBUTE_TYPE artifactAtrributeType) {
        this(searchTerm, isLiteral, true);
        this.artifactAtrributeType = artifactAtrributeType;
    }

    public String getSearchTerm() {
        return searchTerm;
    }

    public boolean searchTermIsLiteral() {
        return isLiteral;
    }

    public boolean searchTermIsWholeWord() {
        return isWholeWord;
    }

    String getSearchTermType() {
        if (isLiteral) {
            if (isWholeWord) {
                return NbBundle.getMessage(NewKeywordPanel.class, "NewKeywordPanel.exactButton.text");
            } else {
                return NbBundle.getMessage(NewKeywordPanel.class, "NewKeywordPanel.substringButton.text");
            }
        } else {
            return NbBundle.getMessage(NewKeywordPanel.class, "NewKeywordPanel.regexButton.text");
        }
    }

    void setArtifactAttributeType(BlackboardAttribute.ATTRIBUTE_TYPE artifactAtrributeType) {
        this.artifactAtrributeType = artifactAtrributeType;
    }

    BlackboardAttribute.ATTRIBUTE_TYPE getArtifactAttributeType() {
        return this.artifactAtrributeType;
    }

    @Override
    public String toString() {
        return String.format("Keyword{searchTerm='%s', isLiteral=%s, isWholeWord=%s}", searchTerm, isLiteral, isWholeWord);
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        Keyword other = (Keyword) obj;
        return (this.searchTerm.equals(other.getSearchTerm())
                && this.isLiteral == other.searchTermIsLiteral()
                && this.isWholeWord == other.searchTermIsWholeWord()
                && this.listName.equals(other.getListName())
                && this.originalTerm.equals(other.getOriginalTerm()));
    }

    @Override
    public int hashCode() {
        int hash = 7;
        hash = 17 * hash + this.searchTerm.hashCode();
        hash = 17 * hash + (this.isLiteral ? 1 : 0);
        hash = 17 * hash + (this.isWholeWord ? 1 : 0);
        return hash;
    }

    String getListName() {
        return listName;
    }

    String getOriginalTerm() {
        return originalTerm;
    }

}