|
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 Document
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.annotations.Annotatable |
---|
addAreaHighlight, addAreaHighlight, addAreaHighlight, addAreaHighlight, addStampAnnotation, addStampAnnotation, addStampAnnotation, addStampAnnotation, addStampImageFile, addStampImageURL, addTextHighlight, addTextHighlight, addTextHighlight, addTextHighlight, applyHighlights, redactText |
Method Detail |
---|
void close() throws java.io.IOException
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.close
in interface java.io.Closeable
java.io.IOException
int getArchiveNodeCount() throws OutsideInException
OutsideInException
FileFormat getFileId(Document.FileIdInfoFlagValue dwFlags) throws OutsideInException
dwFlags
- indicates the type of file format information to returnOutsideInException
ObjectInfo getObjectInfo() throws OutsideInException
Exporter
document is a subobject, an ObjectInfo is returned. Otherwise, the method will return null.OutsideInException
Exporter.newSubObjectExporter()
ArchiveNode getArchiveNode(int nNodeNum) throws OutsideInException
nNodeNum
- zero-based index of node to retrieve information onOutsideInException
void saveArchiveNode(int nNodeNum, java.io.File outFile) throws OutsideInException
nNodeNum
- zero-based index of node to saveoutFile
- destination location of file to writeOutsideInException
void saveArchiveNode(int flags, int param1, int param2, java.io.File outFile) throws OutsideInException
setOpenForNonSequentialAccess(true)
prior to using this method.flags
- special flags coming from SXparam1
- data1 coming from SXparam2
- data2 coming from SXoutFile
- destination location of file to writeOutsideInException
|
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 |