Keyword.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2011-2016 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 org.sleuthkit.datamodel.BlackboardAttribute;

class Keyword {

    private String searchTerm;
    private boolean isLiteral;
    private boolean isWholeWord;
    private BlackboardAttribute.ATTRIBUTE_TYPE artifactAtrributeType;

    Keyword(String searchTerm, boolean isLiteral) {
        this.searchTerm = searchTerm;
        this.isLiteral = isLiteral;
        this.isWholeWord = true;
    }

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

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

    String getSearchTerm() {
        return searchTerm;
    }

    boolean searchTermIsLiteral() {
        return isLiteral;
    }

    boolean searchTermIsWholeWord() {
        return isWholeWord;
    }

    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.searchTerm)
                && this.isLiteral == other.isLiteral
                && this.isWholeWord == other.isWholeWord);
    }

    @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;
    }

}