TextExtractor.java

Go to the documentation of this file.

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

import java.io.Reader;
import java.util.Collections;
import java.util.Map;
import org.openide.util.Lookup;
import org.sleuthkit.autopsy.textextractors.configs.ImageConfig;
import org.sleuthkit.datamodel.AbstractFile;

public interface TextExtractor {

    boolean isSupported();

    Reader getReader() throws InitReaderException;

    default void setExtractionSettings(Lookup context) {
        //no-op by default
    }

    default Map<String, String> getMetadata() {
        return Collections.emptyMap();
    }

    default boolean willUseOCR() {
        return false;
    }

    public class InitReaderException extends Exception {

        public InitReaderException(String msg, Throwable ex) {
            super(msg, ex);
        }

        public InitReaderException(Throwable ex) {
            super(ex);
        }

        public InitReaderException(String msg) {
            super(msg);
        }
    }
}