|
Oracle Outside In Java API Reference 8.5.4 F11002-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Exporter
Main interface for exporting an input document to a specified output format. This is the primary class that exposes the functionality of a conversion. A concrete Exporter
implementation can be obtained by calling the static OutsideIn.newLocalExporter()
method.
Nested Class Summary | |
---|---|
static class |
Exporter.PageInformationValues Describes the list of page level information that can be requested. |
Nested classes/interfaces inherited from interface com.oracle.outsidein.Document |
---|
Document.FileIdInfoFlagValue, Document.SubDocumentIdentifierTypeValue, Document.SubObjectTypeValue |
Method Summary | |
---|---|
void |
addKeyValuePairs(java.util.Map<java.lang.String,java.lang.String> pairs) Associates key/value pairs with the exported document for use in Web View Export (HTML5 destination file format). |
void |
export() Executes a single conversion. |
void |
export(boolean bLeaveSourceOpen) Executes a single conversion and specifies whether to leave the source document open for subsequent conversions or to close the input file immediately after the export completes. |
ExportStatus |
getExportStatus() Obtains information relating to the most recent successful export. |
long |
getPageCount(FileFormat format) Gets the number of pages of output that will be produced when the document is exported to the specified format. |
Exporter |
newArchiveNodeExporter(int dwRecordNum) Creates a new Exporter object using an archive node within the current source file as its input document. |
Exporter |
newArchiveNodeExporter(int flags, int param1, int param2) Creates a new Exporter object using an archive node within the current source file as its input document. |
Exporter |
newSubDocumentExporter(int subdocId, Document.SubDocumentIdentifierTypeValue idType) Creates a new Exporter object that uses an embedding within the current source file as its input document. |
Exporter |
newSubObjectExporter(Document.SubObjectTypeValue objectType, int data1, int data2, int data3, int data4) Creates a new Exporter object using a subobject within the current source file as its input document. |
OptionsCache |
setExportTimeout(int milliseconds) Sets the time that the export process should wait for a response from the Outside In core before interrupting an executing operation. |
void |
setPageInformationRequired(java.util.EnumSet<Exporter.PageInformationValues> infoRequirements) Sets the list of page information that is requested. |
Methods inherited from interface com.oracle.outsidein.Document |
---|
close, getArchiveNode, getArchiveNodeCount, getFileId, getObjectInfo, saveArchiveNode, saveArchiveNode |
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 |
---|
void export() throws OutsideInException
export(false)
. Before calling this method an input file must be specified using setSourceFile(File)
, an output file must be specified using setDestinationFile(File)
, and an output format must be specified using setDestinationFormat(FileFormat)
. Upon successful completion of this method, the output file(s) should be present in the destination location.OutsideInException
- if the conversion fails for any reason.void export(boolean bLeaveSourceOpen) throws OutsideInException
false
as the parameter. However, if exporting the same input file multiple times, then passing true
may provide a performance improvement. Before calling this method an input file must be specified using setSourceFile(File)
, an output file must be specified using setDestinationFile(File)
, and an output format must be specified using setDestinationFormat(FileFormat)
. Upon successful completion of this method, the output file(s) should be present in the destination location.bLeaveSourceOpen
- indicates whether to leave the source openOutsideInException
- if the conversion fails for any reason.ExportStatus getExportStatus()
export()
or null if export()
has never been called for this Exporter
.ExportStatus
Exporter newSubDocumentExporter(int subdocId, Document.SubDocumentIdentifierTypeValue idType) throws OutsideInException
Exporter
object that uses an embedding within the current source file as its input document. The newly created Exporter
will inherit the options set in the Exporter
object that executes this method.subdocId
- The identifier of the subdocidType
- The type of subdocumentExporter
objectOutsideInException
- if the subdocument fails to openDocument.SubDocumentIdentifierTypeValue
Exporter newSubObjectExporter(Document.SubObjectTypeValue objectType, int data1, int data2, int data3, int data4) throws OutsideInException
Exporter
object using a subobject within the current source file as its input document. The newly created Exporter
will inherit the options set in the Exporter
object that executes this method.objectType
- the type of subobject obtained from SearchMLdata1
- Data from SearchML identifying the subobjectdata2
- Data from SearchML identifying the subobjectdata3
- Data from SearchML identifying the subobjectdata4
- Data from SearchML identifying the subobjectExporter
objectOutsideInException
- if the subobject fails to openExporter newArchiveNodeExporter(int dwRecordNum) throws OutsideInException
Exporter
object using an archive node within the current source file as its input document. The newly created Exporter
will inherit the options set in the Exporter
object that executes this method.dwRecordNum
- The 0-based index of the intended nodeExporter
objectOutsideInException
- if the archive node fails to openExporter newArchiveNodeExporter(int flags, int param1, int param2) throws OutsideInException
Exporter
object using an archive node within the current source file as its input document. The newly created Exporter
will inherit the options set in the Exporter
object that executes this method. To use this method, the source file must be run through Search Export, and the resulting xml must be parsed to identify the values that are passed as parameters to this method.flags
- Special flags value from Search Exportparam1
- Data1 value obtained from Search Exportparam2
- Data2 value obtained from Search ExportExporter
objectOutsideInException
- if the archive node fails to openvoid addKeyValuePairs(java.util.Map<java.lang.String,java.lang.String> pairs)
pairs
- key/value pairs where the key is the name of the data.OptionsCache setExportTimeout(int milliseconds)
addSourceFile(File)
, the export of each source file will be treated as a separate operation, and thus, the timeout restarts for each source file instead of applying to the entire export operation.milliseconds
- The maximum number of milliseconds per input document that the export process shall run before being interruptedOptionsCache
object (to allow for chaining set option methods)long getPageCount(FileFormat format) throws OutsideInException
format
- Format to export the document toOutsideInException
- if thevoid setPageInformationRequired(java.util.EnumSet<Exporter.PageInformationValues> infoRequirements) throws OutsideInException
infoRequirements
- Page Information to be retrievedOutsideInException
- if a problem occurs
|
Oracle Outside In Java API Reference 8.5.4 F11002-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |