Overview (Outside In Java API Reference)

Packages
Package	Description
com.oracle.outsidein	Contains the primary Outside In Java API classes.
com.oracle.outsidein.annotations	Facilities for highlighting text and areas of the converted output document.
com.oracle.outsidein.options	Facilities for setting and getting options that can alter the behavior of conversions.

The Oracle Outside In Technology enables developers to extract, convert, and view the contents of over 600 unstructured file formats. This Java API reference describes the public interfaces for the functionality provided by the Outside In Technology. The primary API classes are contained in the com.oracle.outsidein package.

When working with the API, an Exporter object is the primary interface used to configure and perform a conversion. To create a new Exporter object, use the static newLocalExporter() method of the OutsideIn class. The returned Exporter object has many methods inherited from the OptionsCache interface that can be used to set options that alter the behavior of the conversion. The required options for a conversion are setSourceFile(), setDestinationFile(), and setDestinationFormat(FileFormat). Once the desired options are set, call the export() method to perform a conversion and write the destination files. The same Exporter object can be used to convert multiple source files, and options may be changed between conversions. Call the close() method when the Exporter object is no longer needed.