KeywordSearchQuery.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;

interface KeywordSearchQuery {

    KeywordList getKeywordList();

     boolean validate();

     QueryResults performQuery() throws NoOpenCoreException;

     void addFilter(KeywordQueryFilter filter);

     void setField(String field);

     void setSubstringQuery();

     void escape();

     boolean isEscaped();

     boolean isLiteral();

     String getQueryString();

     String getEscapedQueryString();

     KeywordCachedArtifact writeSingleFileHitsToBlackBoard(String termHit, KeywordHit hit, String snippet, String listName);

}