DimDom v0.8.2

org.alltimeflashdreamer.dimdom
Interface XHTMLSiteData

All Known Implementing Classes:
AbstractXHTMLSiteData

public interface XHTMLSiteData

Title: XHTMLSiteData
Description: This is the client interface of the DimDom engine. Each class that shall serve values/commands has to implement at least those interfaces, although it is absolutely recommended to extend AbstractSiteData or even SimpleSiteData, unless you'd like to completely rewrite the DimDom engine.
Note: The methods defined in this interface are those needed by the DimDom class only . Each further code is implementation specified and therefore not listed here.


Method Summary
 String getIdentifier()
          Returns the identifier which is used by the DimDom to know which template source is now to be filled with dynamic data.
 DimDomNode getNextDimDomNode()
          Returns the next implementing object of the DimDomNode interface, to allow the DimDom engine to process the next node (or the next clone of a micro-template node).
 String getString()
          Returns the source string to be parsed.
 String getTemplateFileName()
          Returns the template's file name of the template file to be parsed.
 URL getURL()
          Returns the source URL to parse from.
 String getXHTMLDocumentClassName()
          This method returns the fully qualified class name of the XHTMLDocument implementing class.
 

Method Detail

getIdentifier

public String getIdentifier()
Returns the identifier which is used by the DimDom to know which template source is now to be filled with dynamic data.
Returns:
an identifying string

getXHTMLDocumentClassName

public String getXHTMLDocumentClassName()
This method returns the fully qualified class name of the XHTMLDocument implementing class. This method allows to exchange the template processor. The specified class must be available for the JVM. If not, DimDom gets some ClassNotFoundException which is wrapped in the DimDomException declared in the print method of the DimDom class.
Returns:
the name of the available template processor class; for SimpleSiteData, this is "org.alltimeflashdreamer.dimdom.SimpleXHTMLDocument"

getNextDimDomNode

public DimDomNode getNextDimDomNode()
Returns the next implementing object of the DimDomNode interface, to allow the DimDom engine to process the next node (or the next clone of a micro-template node).
Returns:
the next instance of the DimDomNode implementing class or null, if there aren't more such instances

getString

public String getString()
Returns the source string to be parsed.
Returns:
the source string, if one is set, or null

getTemplateFileName

public String getTemplateFileName()
Returns the template's file name of the template file to be parsed.
Returns:
the template's file name, if one is set, or null

getURL

public URL getURL()
Returns the source URL to parse from.
Returns:
the URL, if one is set, or null

Copyright (c) 2001/02 by Florian Steinsiepe