io.github.oliviercailloux.javagrade.exextractor.SimpleExtractor Maven / Gradle / Ivy
package io.github.oliviercailloux.javagrade.exextractor;
import java.io.IOException;
import java.io.InputStream;
import java.io.Writer;
import java.nio.file.Path;
import java.util.Collection;
import java.util.List;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.encryption.InvalidPasswordException;
import org.apache.pdfbox.text.PDFTextStripper;
/**
*
* Extracts text from PDF. Uses a default {@link PDFTextStripper} if none is provided. It is also
* possible to provide an instance of {@link PDFTextStripper} (using
* {@link #setStripper(PDFTextStripper)}), in which case that instance will be used instead of a
* default one.
*
*
* Following the usual practice, this object does not close the resources it is given, but closes
* the resources it creates.
*
*
* @author Olivier Cailloux
*
*/
public interface SimpleExtractor {
/**
* Sets the text stripper to use in place of the default one.
*
* @param stripper the stripper to use, {@code null} to use the default stripper
*/
public void setStripper(PDFTextStripper stripper);
/**
*
* Extracts text found in the given document, and writes it to the given {@code Writer}.
*
*
* @param document the document to extract text from, if {@code null}, nothing is written
* @param output the writer where content should be written, not {@code null} if {@code input} is
* not null, otherwise, may be {@code null}
* @throws IOException in case of a reading, parsing or writing error
* @see #setStripper(PDFTextStripper)
*/
public void writeTextFromDocument(PDDocument document, Writer output) throws IOException;
/**
*
* Extracts text found in the given input stream representing a non-encrypted PDF, and writes it
* to the given {@code Writer}.
*
*
* Uses the given stripper or a default one if none is provided.
*
*
* @param input the PDF byte stream, if {@code null}, nothing is written
* @param output the writer where content should be written, not {@code null} if {@code input} is
* not null, otherwise, may be {@code null}
* @throws InvalidPasswordException if the PDF required a non-empty password
* @throws IOException in case of a reading, parsing or writing error
* @see #setStripper(PDFTextStripper)
*/
public void writeText(InputStream input, Writer output) throws IOException;
/**
*
* For each path given as input, extracts the text from the corresponding file, assuming it is a
* PDF, and writes it to the given {@code Writer}. The text is written to the output with no
* separation indicating the boundaries of the given PDFs.
*
*
* @param inputPaths not {@code null}, may be empty
* @param output the writer where content should be written, not {@code null} if {@code input} is
* not empty, otherwise, may be {@code null}
* @throws InvalidPasswordException if a PDF required a non-empty password
* @throws IOException in case of a reading, parsing or writing error
* @see #setStripper(PDFTextStripper)
*/
public void writeAllText(Collection inputPaths, Writer output) throws IOException;
/**
*
* For each path given as input, extracts the text from the corresponding file, assuming it is a
* PDF.
*
*
* Uses the given stripper or a default one if none is provided.
*
*
* @param inputPaths not {@code null}, may be empty
* @return a list containing as many entries as in the given collection, not {@code null}, but may
* be empty
*
* @throws InvalidPasswordException if a PDF required a non-empty password
* @throws IOException in case of a reading or parsing error
* @see #setStripper(PDFTextStripper)
*/
public List getAllText(Collection inputPaths) throws IOException;
}