org.enhydra.zeus
Interface Source

All Known Implementing Classes:
BaseSource

public interface Source

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

All input sources should implement this interface, and be named XXXSource where XXX reflects the type of input handled. For example, input from I/O streams is handled by StreamSource.

Author:
Brett McLaughlin

Method Summary
 org.jdom.Document getDocument()
           This will return a JDOM Document that represents the input source.
 java.lang.String getSystemID()
           This will return the system ID associated with this Source.
 void setEntityResolver(org.xml.sax.EntityResolver entityResolver)
           This will set an EntityResolver for this Source.
 void setSystemID(java.lang.String systemID)
           This will set the system ID for this Source.
 

Method Detail

getSystemID

public java.lang.String getSystemID()

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

Returns:
String - the system ID for the Source.

setSystemID

public void setSystemID(java.lang.String systemID)

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

Parameters:
systemID - String system ID to use.

getDocument

public org.jdom.Document getDocument()
                              throws java.io.IOException

This will return a JDOM Document that represents the input source.

Returns:
Document - the JDOM representation of the input source.
Throws:
IOException - - when construction of a Document generates errors.

setEntityResolver

public void setEntityResolver(org.xml.sax.EntityResolver entityResolver)

This will set an EntityResolver for this Source. This is passed to the underlying parser to use.

Parameters:
entityResolver - EntityResolver to use during parsing.


Copyright © 2002 Enhydra. All Rights Reserved.