AdditionalAPIFeatures

Basic examples were presented for using the two API interface approaches to execute an XAware BizView and process the XML results. The complete API includes other classes and methods that provide additional capabilities. Below is a summary of some of these features. Refer to the API documentation in the /javadoc directory for a complete list of features and options. For more information, contact XAware at support@xaware.com or post a question on our forum at http://www.xaware.org.

Contents 1 BizView Reference 2 Input and Output XML 3 Response Processing 4 Caching and Pooling

BizView Reference

The BizView to be executed may be set as either a full file path specification or as an XAware relative reference to a path in a .xar file, specified by a resource path. We recommend using the resource path, as shown in the samples, since the XA-Designer builds components with relative paths by default and provides the Package Assembly Tool to easily package components into a .xar file.

Input and Output XML

The Detailed Level interface includes multiple methods of providing the Input XML to the BizDocument including the capability to provide the data as in input stream. There are five (mutually exclusive) setter methods to pass the input XML as a filename to be read, an XML Reader, a serialized string, an Input Stream or JDOM document.

The Detailed Level interface also includes multiple methods to output the results of the BizView execution to a file. There are three (mutually exclusive) setter methods to specify the destination to write the execution results including be read, an Output Stream name, an Output Writer and an Output Stream.

Response Processing

As described, the execution results may be obtained as a String, JDOM Document or W3C Document. The results may also be obtained in a BizViewResponse object. This class provides methods to obtain the same string or DOM object result, and it provides a status of the execution. It also provides the capability to obtain the String result as a formatted XML string using an internal “pretty print” format or by providing your own formatter.

Caching and Pooling

Using either interface, multiple BizDocs may be executed after the engine is initialized. The XAware Engine also caches and pools the meta documents (in memory), after the initial execution of each BizDoc. This optimizes execution performance so that the meta files do not have to be parsed and loaded again. After BizDoc execution, you can use the XABizView.release() method to clear all caches and pools to optimize memory performance or to allow meta files updates to be processed.