KeywordSearchQuery.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2011 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.AbstractFile;

interface KeywordSearchQuery {
    
    KeywordList getKeywordList();

    public boolean validate();

    
    public QueryResults performQuery() throws NoOpenCoreException;
    
    
    public void addFilter(KeywordQueryFilter filter);
    
    public void setField(String field);
    
    public void setSubstringQuery();
    
    public void escape();
    
    public boolean isEscaped();
    
    public boolean isLiteral();
    
    public String getQueryString();
    
    public String getEscapedQueryString();
        
    public KeywordCachedArtifact writeSingleFileHitsToBlackBoard(String termHit, KeywordHit hit, String snippet, String listName);

}