ExtractionOptions Class

ExtractionOptions (attached to a FileConvertJob) specifies how embedded images and attachments should be handled.

File

File: ExtractionOptions.java

Syntax

Java

public class ExtractionOptions;

Methods

Method	Description
setAllowedExtensions	If the dtsExoLimitExtensions flag is set, image and attachment filename extensions will be limited to the values listed in allowedExtensions.
setDefaultExtension	Extension to add to images and attachments when the dtsExoLimitExtensions flags is set and an image or attachment has an extension that is not listed in allowedExtensions.
setFilenamePrefix	Filename prefix for extracted files stored in outputLocation
setFlags	ExtractionOptionsFlags value.
setOutputFileListName	Name of text file to create with the names of all images and attachments extracted to the outputLocation.
setOutputLocation	Output folder for images and attachments extracted from the input file
setOutputReference	URL of the outputLocation for links in the conversion output.
setUnnamedAttachmentLinkText	Text to use for link to an attachment that has no name

Remarks

During conversion, embedded images and attachments can be extracted to a folder, with links to the extracted images and attachments inserted in the output.

Example:

com.dtsearch.engine.FileConverter cj = new com.dtsearch.engine.FileConverter(); cj.setInputFile(inputFilename); cj.setOutputToString(true); cj.setOutputFormat(com.dtsearch.engine.OutputFormats.itHTML); com.dtsearch.engine.ExtractionOptions exo = new com.dtsearch.engine.ExtractionOptions(); exo.setOutputLocation("c:\\output"); exo.setOutputReference("c:\\output"); // This prevents attachments from being written with executable extensions like .exe or .bat exo.setAllowedExtensions("doc docx xls xlsx ppt pptx jpg jpeg png txt zip xml pdf wpd"); // Attachments with disallowed extensions will have ".data" appended to the filename exo.setDefaultExtension("data"); exo.setFlags(ExtractionOptionsFlags.dtsExoExtractImages | ExtractionOptionsFlags.dtsExoExtractAttachments | ExtractionOptionsFlags.dtsExoLimitExtensions); cj.setExtractionOptions(exo); cj.execute();

When highlighting hits, flags should be consistent with the behavior of the indexer or hit highlighting will be inconsistent.

dtsExoExtractAttachments should not be used when highlighting hits because in some cases text is added to the conversion output to provide a location for the link to the extracted attachment.

dtsExoDoNotConvertAttachments should not be used when highlighting hits because the indexer does convert attachments to text.

dtsExoExtractImages can be used when highlighting hits.

Class Hierarchy

com.dtsearch.engine.ExtractionOptions