DimDom v0.8.2

org.alltimeflashdreamer.dimdom
Interface XHTMLDocument

All Known Implementing Classes:
AbstractXHTMLDocument

public interface XHTMLDocument

Title: XHTMLDocument
Description: This interface declares the two central methods of the DimDom engine: print and setSiteData. Each template/command pair that shall be processed by the DimDom engine needs to implement this interface which makes a XHTMLDocument out of it. This means that the underlying org.w3c.dom.Document instance represents pure XML (with HTML tag names), is dynamizable and printable using the DOMFormatter.


Method Summary
 String print()
          Forces the HTMLDocument to print out its dynamically adapted content as a String.
The exception that may be thrown is one of the processing of the dynamic data or of the HTMLFormatter.
 void setSiteData(XHTMLSiteData siteData)
          This method is (typically) called by the servlet instantiating a specific subclass of this class that needs to be filled with dynamic data.
It is defined within a separate interface to hide the functionality of implementing classes to the servlet programmer, because the updating process is uni-directional (thread safety!).
 

Method Detail

print

public String print()
             throws IOException,
                    DimDomException
Forces the HTMLDocument to print out its dynamically adapted content as a String.
The exception that may be thrown is one of the processing of the dynamic data or of the HTMLFormatter.
Returns:
the full HTML string
Throws:
IOException - thrown by the parser (input source)
DimDomException - thrown by the processor, if something is/went wrong

setSiteData

public void setSiteData(XHTMLSiteData siteData)
                 throws SAXException,
                        IOException,
                        DimDomException
This method is (typically) called by the servlet instantiating a specific subclass of this class that needs to be filled with dynamic data.
It is defined within a separate interface to hide the functionality of implementing classes to the servlet programmer, because the updating process is uni-directional (thread safety!).
Parameters:
siteData - an instance of a class implementing org.alltimeflashdreamer.dimdom.XHTMLSiteData
Throws:
SAXException - thrown by the parser
IOException - thrown by the parser (input source)
DimDomException - thrown by the processor, if something is/went wrong

Copyright (c) 2001/02 by Florian Steinsiepe