Skip navigation links

com.oracle.outsidein
Interface Document

All Superinterfaces:

Annotatable, java.io.Closeable, OptionsCache

All Known Subinterfaces:

Exporter

public interface Document

extends OptionsCache, Annotatable, java.io.Closeable

Interface for interacting with a source document. Currently, the only public implementation of this interface is retrieved through OutsideIn.newLocalExporter() which returns an Exporter object that extends this Document interface.

Nested Class Summary

static class	Document.FileIdInfoFlagValue Enumeration indicating what type of file format identification information to return from getFileId().
static class	Document.SubDocumentIdentifierTypeValue Type of subdocument Exporter to create when calling Exporter.newSubDocumentExporter()
static class	Document.SubObjectTypeValue Type of subobject Exporter to create when calling Exporter.newSubObjectExporter()

Method Summary

void	close() Closes the Exporter object.
ArchiveNode	getArchiveNode(int nNodeNum) Retrieves information on an archive node.
int	getArchiveNodeCount() Retrieves the number of nodes in an archive file.
FileFormat	getFileId(Document.FileIdInfoFlagValue dwFlags) Retrieves the file format for a source document.
ObjectInfo	getObjectInfo() Retrieves information about the current subobject.
void	saveArchiveNode(int nNodeNum, java.io.File outFile) Saves an archive node to a local file.
void	saveArchiveNode(int flags, int param1, int param2, java.io.File outFile) Saves an archive node to a local file without reading all nodes in the archive sequentially.

Methods inherited from interface com.oracle.outsidein.options.OptionsCache

addSourceFile, addSourceFile, addSourceFile, getAcceptAlternateGraphics, getAppendEmailAttachments, getApplyZLIBCompression, getBiDiReorderMethod, getBorderMode, getCollapseWhiteSpace, getCropToContent, getDefaultInputCharacterSet, getDefaultPageMargins, getDefaultPageSize, getDefaultRenderFont, getDestinationFormat, getDetectGrayScaleAsColor, getDocumentMemoryMode, getDropPDFHyphens, getEmailAttachmentHandling, getEmailHeaders, getEmbedFonts, getEnableAllSubObjects, getEnableAlphaBlending, getExportPerformanceMode, getExternalStylesheets, getExtractEmbeddedFiles, getExtractXMPMetadata, getFallbackFormat, getFitHeightToPages, getFitWidthToPages, getFontAliasList, getFontBaseURL, getFontDirectories, getFontFilter, getFontReferenceMethod, getGenerateBulletsAndNumbering, getGenerateExcelRevisions, getGenerateJavascriptTabs, getGraphicHeight, getGraphicHeightLimit, getGraphicOutputDPI, getGraphicRenderAsPage, getGraphicSizeLimit, getGraphicSizeMethod, getGraphicWidth, getGraphicWidthLimit, getGridMaxPageHeight, getGridMaxPageWidth, getGridWrap, getHTMLFlavor, getHTMLOutputFormatting, getIECondCommentMode, getIgnorePassword, getImagePassthrough, getIncludeCharacterAttributes, getIncludeSearchMLOffset, getInterlacedGIFs, getInternalRendering, getISODateTimes, getJPEGQuality, getLinearizePDFOutput, getLotusNotesDirectory, getMarginText, getMarginTextFont, getNullReplacementCharacter, getOutputChangeTracking, getOutputCharacterSet, getOutputGraphicType, getOutputRawtext, getPageBreakLimit, getPageDirection, getPageFitMode, getPageMLFlags, getPageRange, getPageScalePercent, getParseXMPMetadata, getPDFInputMaxEmbeddedObjects, getPDFInputMaxVectorPaths, getPDFReorderBiDi, getPDFWordSpacingFactor, getPerformExtendedFI, getPostLibraryScripts, getPreLibraryScripts, getPreventGraphicOverlap, getPrinterName, getProcessOLEEmbeddingMode, getQuickThumbnail, getRawTextBufferSize, getRedactionColor, getRedactionLabelFont, getRedactionLabelsVisible, getRedactionsEnabled, getRenderEmbeddedFonts, getRenderGridlines, getRenderHeadings, getSearchMLFlags, getSearchMLParaAttributes, getShowArchiveFullPath, getShowColumnHeadings, getShowHiddenCells, getShowHiddenSpreadSheetData, getShowHiddenText, getSimpleStyleNames, getStrictFile, getStrokeOutText, getSuppressEmptyCells, getSuppressFontAttributes, getTempDirectory, getTIFFByteOrder, getTIFFColorSpace, getTIFFCompression, getTIFFFillOrder, getTIFFMultiPage, getTimeZoneOffset, getTransparencyColor, getUnicodeByteOrder, getUnmappableCharacter, getUnmappedText, getURLPathOutput, getURLPathResources, getUseDocumentPageSettings, getVectorObjectLimit, getWatermark, getWebFontPermissions, getWebViewLibraryName, getWebViewStructure, getWebViewStylesheetName, getXMLDefinitionReference, getXXFormatOptions, setAcceptAlternateGraphics, setAppendEmailAttachments, setApplyZLIBCompression, setBiDiReorderMethod, setBorderMode, setCallbackHandler, setCollapseWhiteSpace, setCropToContent, setDefaultInputCharacterSet, setDefaultPageMargins, setDefaultPageSize, setDefaultRenderFont, setDestinationFile, setDestinationFile, setDestinationFormat, setDetectGrayScaleAsColor, setDocumentMemoryMode, setDropPDFHyphens, setEmailAttachmentHandling, setEmailHeaders, setEmbedFonts, setEnableAllSubObjects, setEnableAlphaBlending, setExportPerformanceMode, setExportTemplate, setExternalStylesheets, setExtractEmbeddedFiles, setExtractXMPMetadata, setFallbackFormat, setFitHeightToPages, setFitWidthToPages, setFontAliasList, setFontBaseURL, setFontDirectories, setFontFilter, setFontReferenceMethod, setGenerateBulletsAndNumbering, setGenerateExcelRevisions, setGenerateJavascriptTabs, setGraphicHeight, setGraphicHeightLimit, setGraphicOutputDPI, setGraphicRenderAsPage, setGraphicSizeLimit, setGraphicSizeMethod, setGraphicWidth, setGraphicWidthLimit, setGridMaxPageHeight, setGridMaxPageWidth, setGridWrap, setHTMLFlavor, setHTMLOutputFormatting, setIECondCommentMode, setIgnorePassword, setImagePassthrough, setIncludeCharacterAttributes, setIncludeSearchMLOffset, setInterlacedGIFs, setInternalRendering, setISODateTimes, setJPEGQuality, setLinearizePDFOutput, setLotusNotesDirectory, setLotusNotesId, setMarginText, setMarginTextFont, setNullReplacementCharacter, setOpenForNonSequentialAccess, setOutputChangeTracking, setOutputCharacterSet, setOutputGraphicType, setOutputRawtext, setPageBreakLimit, setPageDirection, setPageFitMode, setPageMLFlags, setPageRange, setPageScalePercent, setParseXMPMetadata, setPasswordsList, setPDFInputMaxEmbeddedObjects, setPDFInputMaxVectorPaths, setPDFReorderBiDi, setPDFWordSpacingFactor, setPerformExtendedFI, setPostLibraryScripts, setPreLibraryScripts, setPreventGraphicOverlap, setPrinterName, setProcessOLEEmbeddingMode, setQuickThumbnail, setRawTextBufferSize, setRedactionColor, setRedactionLabelFont, setRedactionLabelsVisible, setRedactionsEnabled, setRenderEmbeddedFonts, setRenderGridlines, setRenderHeadings, setSearchMLFlags, setSearchMLParaAttributes, setShowArchiveFullPath, setShowColumnHeadings, setShowHiddenCells, setShowHiddenSpreadSheetData, setShowHiddenText, setSimpleStyleNames, setSourceFile, setSourceFile, setSourceFile, setSourceFormat, setStrictFile, setStrokeOutText, setSuppressEmptyCells, setSuppressFontAttributes, setTempDirectory, setTIFFByteOrder, setTIFFColorSpace, setTIFFCompression, setTIFFFillOrder, setTIFFMultiPage, setTimeZoneOffset, setTransparencyColor, setUnicodeByteOrder, setUnmappableCharacter, setUnmappedText, setURLPathOutput, setURLPathResources, setUseDocumentPageSettings, setVectorObjectLimit, setWatermark, setWebFontPermissions, setWebViewLibraryName, setWebViewStructure, setWebViewStylesheetName, setXMLDefinitionReference, setXXFormatOptions

Methods inherited from interface com.oracle.outsidein.annotations.Annotatable

addAreaHighlight, addAreaHighlight, addAreaHighlight, addAreaHighlight, addStampAnnotation, addStampAnnotation, addStampAnnotation, addStampAnnotation, addStampImageFile, addStampImageURL, addTextHighlight, addTextHighlight, addTextHighlight, addTextHighlight, applyHighlights, redactText

Method Detail

close

void close()
           throws java.io.IOException

Closes the Exporter object. This must be called to clean up resources used by an Exporter object. Once the Exporter has been closed, it must no longer be used. In Java 1.7 and greater, try-with-resources can be used for Exporter objects to call this method automatically.

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException

getArchiveNodeCount

int getArchiveNodeCount()
                        throws OutsideInException

Retrieves the number of nodes in an archive file.

Returns:

the number of nodes in an archive file or 0 if the file is not an archive

Throws:

OutsideInException

getFileId

FileFormat getFileId(Document.FileIdInfoFlagValue dwFlags)
                     throws OutsideInException

Retrieves the file format for a source document.

Parameters:

dwFlags - indicates the type of file format information to return

Returns:

the file format of the source file

Throws:

OutsideInException

getObjectInfo

ObjectInfo getObjectInfo()
                         throws OutsideInException

Retrieves information about the current subobject.

Returns:

if the current Exporter document is a subobject, an ObjectInfo is returned. Otherwise, the method will return null.

Throws:

OutsideInException

See Also:

Exporter.newSubObjectExporter()

getArchiveNode

ArchiveNode getArchiveNode(int nNodeNum)
                           throws OutsideInException

Retrieves information on an archive node.

Parameters:

nNodeNum - zero-based index of node to retrieve information on

Returns:

object containing information on the requested archive node

Throws:

OutsideInException

saveArchiveNode

void saveArchiveNode(int nNodeNum,
                     java.io.File outFile)
                     throws OutsideInException

Saves an archive node to a local file.

Parameters:

nNodeNum - zero-based index of node to save

outFile - destination location of file to write

Throws:

OutsideInException

saveArchiveNode

void saveArchiveNode(int flags,
                     int param1,
                     int param2,
                     java.io.File outFile)
                     throws OutsideInException

Saves an archive node to a local file without reading all nodes in the archive sequentially. To use this version of the method, you must first process the archive with Search Export and save the Node Locator data for use in the parameters. You must also call setOpenForNonSequentialAccess(true) prior to using this method.

Parameters:

flags - special flags coming from SX

param1 - data1 coming from SX

param2 - data2 coming from SX

outFile - destination location of file to write

Throws:

OutsideInException

Skip navigation links