org.enhydra.zeus.result
Class BaseResult

Direct Known Subclasses:
StreamResult

public abstract class BaseResult
implements 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.

This implementation of Result handles the basic functionality of dealing with system IDs so that other implementations don't have to code these methods. Thus, XXXResult classes should extend this class, rather than directly implementing Result, and will get this functionality "for free."

Author:
Brett McLaughlin
Version: 1.0

Method Summary
 StringgetSystemID()
           This will return the system ID associated with this Result.
 voidsetSystemID(String systemID)
           This will set the system ID for this Result.
 abstract voidwrite(String output)
           This will write a character stream to the output facility associated with this Result.

Method Detail

getSystemID

public 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(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 abstract void write(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.

Association Links

to Class java.lang.String

The system ID for this Result