org.apache.cocoon.generation
Class XMLDBGenerator

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLoggable
        |
        +--org.apache.cocoon.xml.AbstractXMLProducer
              |
              +--org.apache.cocoon.generation.AbstractGenerator
                    |
                    +--org.apache.cocoon.generation.ComposerGenerator
                          |
                          +--org.apache.cocoon.generation.XMLDBGenerator

All Implemented Interfaces:

Cacheable, org.apache.avalon.framework.component.Component, org.apache.avalon.framework.component.Composable, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.activity.Disposable, Generator, org.apache.avalon.framework.activity.Initializable, org.apache.avalon.framework.logger.Loggable, org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, SitemapModelComponent, XMLProducer

Deprecated. Use the XML:DB pseudo protocol instead.

public class XMLDBGenerator

extends ComposerGenerator

implements Cacheable, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.activity.Initializable

This class implements generation of XML documents from a XML:DB compliant database. It must to be configured as follows:

 <driver>
   (a valid DB:XML compliant driver)
 </driver>
 <base>
   xmldb:yourdriver://host/an/optional/path/to/be/prepended
 </base>
 

NOTE: the driver can be any DB:XML compliant driver (although this component has been tested only with dbXML, and the trailing slash in the base tag is important!

Version:

CVS $Id: XMLDBGenerator.java,v 1.6 2002/02/23 16:47:39 gianugo Exp $

Author:

Gianugo Rabellino

Field Summary

protected java.lang.String	base Deprecated.
protected java.lang.String	col Deprecated.
protected org.xmldb.api.base.Collection	collection Deprecated.
protected org.xmldb.api.base.Database	database Deprecated.
protected java.lang.String	driver Deprecated.
protected java.lang.String	res Deprecated.
protected org.xmldb.api.modules.XMLResource	xmlResource Deprecated.

Fields inherited from class org.apache.cocoon.generation.ComposerGenerator

manager

Fields inherited from class org.apache.cocoon.generation.AbstractGenerator

objectModel, parameters, resolver, source

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.generation.Generator

ROLE

Constructor Summary

XMLDBGenerator()
Deprecated.

Method Summary

void	compose(org.apache.avalon.framework.component.ComponentManager manager) Deprecated. Set the current ComponentManager instance used by this Composable.
void	configure(org.apache.avalon.framework.configuration.Configuration conf) Deprecated. Configure the component.
void	generate() Deprecated. Parse the requested URI, connect to the XML:DB database and fetch the requested resource.
long	generateKey() Deprecated. The component isn't cached (yet)
CacheValidity	generateValidity() Deprecated. The component isn't cached (yet)
CacheValidity	getValidity() Deprecated. The component isn't cached (yet)
void	initialize() Deprecated. Initialize the component getting a database instance.
void	recycle() Deprecated. Recycle the component, keep only the configuration variables and the database instance for reuse.
void	setup(SourceResolver resolver, java.util.Map objectModel, java.lang.String src, org.apache.avalon.framework.parameters.Parameters par) Deprecated. Set the SourceResolver, object model Map, the source and sitemap Parameters used to process the request.

Methods inherited from class org.apache.cocoon.generation.ComposerGenerator

dispose

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

Methods inherited from class org.apache.avalon.framework.logger.AbstractLoggable

getLogger, setLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Detail

driver

protected java.lang.String driver

Deprecated.

base

protected java.lang.String base

Deprecated.

col

protected java.lang.String col

Deprecated.

res

protected java.lang.String res

Deprecated.

database

protected org.xmldb.api.base.Database database

Deprecated.

collection

protected org.xmldb.api.base.Collection collection

Deprecated.

xmlResource

protected org.xmldb.api.modules.XMLResource xmlResource

Deprecated.

Constructor Detail

XMLDBGenerator

public XMLDBGenerator()

Deprecated.

Method Detail

compose

public void compose(org.apache.avalon.framework.component.ComponentManager manager)
             throws org.apache.avalon.framework.component.ComponentException

Deprecated.

Description copied from class: ComposerGenerator

Set the current ComponentManager instance used by this Composable.

Overrides:

compose in class ComposerGenerator

recycle

public void recycle()

Deprecated.

Recycle the component, keep only the configuration variables and the database instance for reuse.

Overrides:

recycle in class AbstractGenerator

configure

public void configure(org.apache.avalon.framework.configuration.Configuration conf)
               throws org.apache.avalon.framework.configuration.ConfigurationException

Deprecated.

Configure the component. This class is expecting a configuration like the following one:

 <driver>org.dbxml.client.xmldb.DatabaseImpl</driver>
 <base>xmldb:dbxml:///db/</base>
 

NOTE: the driver can be any DB:XML compliant driver (although this component has been tested only with dbXML, and the trailing slash in the base tag is important!

Specified by:

configure in interface org.apache.avalon.framework.configuration.Configurable

Throws:

org.apache.avalon.framework.configuration.ConfigurationException - (configuration invalid or missing)

initialize

public void initialize()
                throws java.lang.Exception

Deprecated.

Initialize the component getting a database instance.

Specified by:

initialize in interface org.apache.avalon.framework.activity.Initializable

Throws:

java.lang.Exception - if an error occurs

setup

public void setup(SourceResolver resolver,
                  java.util.Map objectModel,
                  java.lang.String src,
                  org.apache.avalon.framework.parameters.Parameters par)
           throws ProcessingException,
                  org.xml.sax.SAXException,
                  java.io.IOException

Deprecated.

Description copied from class: AbstractGenerator

Set the SourceResolver, object model Map, the source and sitemap Parameters used to process the request.

Overrides:

setup in class AbstractGenerator

getValidity

public CacheValidity getValidity()

Deprecated.

The component isn't cached (yet)

generateValidity

public CacheValidity generateValidity()

Deprecated.

The component isn't cached (yet)

Specified by:

generateValidity in interface Cacheable

Following copied from interface: org.apache.cocoon.caching.Cacheable

Returns:

The generated validity object or null if the component is currently not cacheable.

generateKey

public long generateKey()

Deprecated.

The component isn't cached (yet)

Specified by:

generateKey in interface Cacheable

Following copied from interface: org.apache.cocoon.caching.Cacheable

Returns:

The generated key or 0 if the component is currently not cacheable.

generate

public void generate()
              throws java.io.IOException,
                     org.xml.sax.SAXException,
                     ProcessingException

Deprecated.

Parse the requested URI, connect to the XML:DB database and fetch the requested resource.

Throws:

ProcessingException - something unexpected happened with the DB