KeyView 24.3

# Input/Output Operations

Methods in the Filter Java API have signatures that support a variety of input and output methods. The input source can usually be a physical file accessed through a file path, a `com.verity.api.SeekableInputStream` or a standard `java.io.InputStream`. You can send the output to a file or `java.io.OutputStream`, or return it one chunk at a time in a byte array.

You can set the input source by calling the `setInputSource` method. Alternatively, you can supply it as a parameter when you use the `doFilter`, `canFilter`, `canFilterEx`, `getDocFormatInfo`, or `getSummaryInfo` methods.

KeyView needs to access different parts of files while it is filtering. When the input source is a stream, OpenText recommends passing a `SeekableInputStream` into KeyView, because it allows KeyView to only read the parts of the stream it needs to read. If you use a Java `InputStream`, KeyView must store the stream as it is received, writing to a temporary file if the stream is large.

If you use a Java InputStream as the source, there are two available method signatures for functions. One method signature allows you to pass in the stream size. If you do not supply the stream size, KeyView reads the entire stream before processing starts. If you can provide the stream size, KeyView might not need to read the whole stream.

Copyright 1997-2024 Open Text
Version 24.3 | Last updated June 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL KeyView 24.3

Topic Title: Input/Output Operations