Package Summary

This section provides a brief description of these Stylus Studio Java API packages:

Javadoc for the Stylus Studio Java API

Javadoc for the Stylus Studio Java API is installed with Stylus Studio. It is available in the Stylus Studio /doc/Javadoc directory. Open index.html to get started. The Javadoc is also available on the Stylus Studio Web site, http://www.StylusStudio.com .

com.stylusstudio.converter

You use the classes and interfaces in the com.stylusstudio.converter package to access EDI, CSV, and other flat-file data sources from a Java application using the Stylus Studio adapter: URL scheme.

Class
Description
Configuration
Public class used to specify user-settable policies for a Configuration object. These policies govern certain aspects of the conversion process, such as memory and buffer settings.
ConverterFactory
Public class used to create new Converter objects. Converter objects are used to convert files to and from XML.
InputStreamResult
Public class used to specify that the user of Converter wants to read the result of the conversion with a InputStream.
OutputResult
Public class used to specify that the user of Converter wants the Converter to write its output to a Writer provided by the caller, or wants the Converter to write its output to a OutputStream provided by the caller using a specified byte encoding.
OutputStreamSource
Public class used to specify that the user of Converter wants to provide the source data for the conversion by writing it to a OutputStream.
ReaderResult
Public class used to specify that the user of Converter wants to read the result of the conversion with a Reader.
WriterSource
Public class used to specify that the user of Converter wants to provide the source data for the conversion by writing it to a Writer.
Conversion
Public interface that controls the conversion process. The application can query the status of the conversion, report errors, cancel the conversion, or finish it.
Converter
Public interface performs the conversion of XML to non-XML, and vice versa.
SAXConversion
Public interface that controls the conversion process for SAXSource objects. The application can query the status of the conversion, report errors, cancel the conversion, or finish it. SAXConversion is an extension of Conversion.
Table 145. com.exln.stylus.io Package Classes

com.exln.stylus.io

You use the classes and interfaces in the com.exln.stylus.io package to access non-XML data sources from XQuery or XSLT using one of several built-in URL schemes ( ws:, db:, dbxml:, and xquery:). You can also register your own scheme to access a custom file system built with the classes in this package.

Though you can also use classes in the com.exln.stylus.io package to access EDI, CSV, and other flat file data sources in a Java application. the classes Stylus Studio com.stylusstudio.converter package are preferred for this purpose.

Class
Description
StylusFileFactory
Public final class that defines a factory API that enables applications to read and write data streams using any file system that implements the StylusFile interface.
StylusFileHelpers
Public class of static helpers for use with StylusFile and StylusFileSystem interfaces and the StylusFile class.
StylusFile
Public interface that provides an abstract representation of a file in a custom file system.
StylusFileSystem
Public interface that represents a custom file system, enabling you to connect to and and browse files on that file system.
StylusFileSystemOptions
Public interface that provides optional methods.
Table 146. com.exln.stylus.io Package Classes

com.stylusstudio.version

com.stylusstudio.version is a simple package, consisting of a single class, version, that enables you to get the current build number of the installed Stylus Studio product. Version numbers of both Stylus Studio 2007 XML Enterprise Suite and the Stylus Studio Java API will be the same.

Class
Description
Version
A class containing version identification information. Includes methods that get the software build number and product name, and that write that information to System.out
Table 147. com.stylusstudio.version Package Classes

 
Free Stylus Studio XML Training:
W3C Member