org.enhydra.zeus
Interface Result

All Known Implementing Classes:
BaseResult

public interface Result

Result provides an interface for all output means. It details the required contract that other portions of the Zeus XML data binding framework must use for processing to an arbitrary output.

All output facilities should implement this interface, and be named XXXResult where XXX reflects the type of output handled. For example, output to I/O streams is handled by StreamResult.

Author:
Brett McLaughlin

Method Summary
 java.lang.String getSystemID()
           This will return the system ID associated with this Result.
 void setSystemID(java.lang.String systemID)
           This will set the system ID for this Result.
 void write(java.lang.String output)
           This will write a character stream to the output facility associated with this Result.
 

Method Detail

getSystemID

public java.lang.String getSystemID()

This will return the system ID associated with this Result. This is generally in the form of a URI.

Returns:
String - the system ID for the Result.

setSystemID

public void setSystemID(java.lang.String systemID)

This will set the system ID for this Result. This is important to use, even when output is in the form of an output stream (see StreamResult) for resolving external references, such as to a DTD.

Parameters:
systemID - String system ID to use.

write

public void write(java.lang.String output)
           throws java.io.IOException

This will write a character stream to the output facility associated with this Result. No additional formatting is added, so line feeds, tabs, or other special characters should be handled by the code performing output.

Parameters:
output - String to output.
Throws:
IOException - - when errors in output occur.


Copyright © 2001 Enhydra. All Rights Reserved.