com.ddtek.xmlconverter
Interface Converter

All Known Subinterfaces:

ConvertFromXML, ConvertToXML

public interface Converter

Instances of this class perform conversion from XML to non-XML, and vice versa.

Instances are created using several static methods in the class ConverterFactory.
The actual conversion is then started with the method convert.
Certain policies can be set by the application in the Configuration object.
Instances of this class are thread safe: an application can use the same Converter object to do multiple conversions simultaneously in different threads.

Method Summary

Conversion	convert(Source source, Result result) Start the conversion and (possibly) wait for completion.
Configuration	getConfiguration() Get the Configuration object for this Converter.
ErrorHandler	getErrorHandler() Get the ErrorHandler previously set with setErrorHandler.
ErrorListener	getErrorListener() Get the ErrorListener previously set with setErrorListener.
OutputStream	getOutputStream(Result result) Get a OutputStream to write the input data to.
void	setErrorHandler(ErrorHandler handler) Set an ErrorHandler to which errors should be reported by the converter.
void	setErrorListener(ErrorListener listener) Set an ErrorListener to which errors should be reported by the converter.

Method Detail

convert

public Conversion convert(Source source,
                          Result result)
                   throws ConverterException

Start the conversion and (possibly) wait for completion.
It is important to note that after this method returns, the conversion might not yet be complete, however it is safe to immediately call convert again on the same Converter object.

If the application is pushing data into the Converter (using OutputStreamSource, WriterSource, or SAXSource), then the conversion will not be finished until all data has been delivered and the appropriate end-of-data indication has been delivered.

Parameters:

source - is an instance of Source.

The following source classes are supported for conversion to XML.

• StreamSource
• OutputStreamSource
• WriterSource

In addition to the above, the following source classes are supported for conversion from XML.

• DOMSource
• SAXSource

result - is an instance of Result.

The following result classes are supported for conversion from XML.

• StreamResult
• OutputResult
• InputStreamResult
• ReaderResult

In addition to the above, the following result classes are supported for conversion to XML.

• DOMResult
• SAXResult

Returns:

The Conversion object that represents the conversion. The application can ignore this return value if it desires, however the application can use the returned Conversion object to gain additional control over the conversion process. If the source object is a SAXSource, then the object returned by convert is a .....; otherwise it is a Conversion.

Throws:

ConverterException

getOutputStream

public OutputStream getOutputStream(Result result)
                             throws ConverterException

Get a OutputStream to write the input data to. This method does not start the conversion, that occurs when the application writes the input data to, and closes the OutputStream.

Parameters:

result - A Result object specifying where the converted data should be written.

Returns:

A OutputStream.

Throws:

ConverterException - if an error occurs

getConfiguration

public Configuration getConfiguration()

Get the Configuration object for this Converter. The caller can modify the returned Configuration object. Any changes affect subsequent conversions done with this Converter object.

Returns:

The Converter's Configuration object.

setErrorListener

public void setErrorListener(ErrorListener listener)

Set an ErrorListener to which errors should be reported by the converter. Calling this method will replace any previously set ErrorHandler or ErrorListener.

getErrorListener

public ErrorListener getErrorListener()

Get the ErrorListener previously set with setErrorListener.

setErrorHandler

public void setErrorHandler(ErrorHandler handler)

Set an ErrorHandler to which errors should be reported by the converter. Calling this method will replace any previously set ErrorHandler or ErrorListener.

getErrorHandler

public ErrorHandler getErrorHandler()

Get the ErrorHandler previously set with setErrorHandler.