org.enhydra.zeus.result
Class BaseResult

java.lang.Object
  |
  +--org.enhydra.zeus.result.BaseResult
All Implemented Interfaces:
Result
Direct Known Subclasses:
StreamResult

public abstract class BaseResult
extends java.lang.Object
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."

Version:
1.0
Author:
Brett McLaughlin

Field Summary
protected  java.lang.String systemID
          The system ID for this Result
 
Constructor Summary
BaseResult()
           
 
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.
abstract  void write(java.lang.String output)
           This will write a character stream to the output facility associated with this Result.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

systemID

protected java.lang.String systemID
The system ID for this Result
Constructor Detail

BaseResult

public BaseResult()
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.

Specified by:
getSystemID in interface Result
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.

Specified by:
setSystemID in interface Result
Parameters:
systemID - String system ID to use.

write

public abstract 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.

Specified by:
write in interface Result
Parameters:
output - String to output.
Throws:
IOException - - when errors in output occur.


Copyright © 2001 Enhydra. All Rights Reserved.