Save This Page
Home » cocoon-2.1.11-src » org.apache » cocoon » generation » [javadoc | source]
org.apache.cocoon.generation
public class: XMLDBCollectionGenerator [javadoc | source]
java.lang.Object
   org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.xml.AbstractXMLProducer
         org.apache.cocoon.generation.AbstractGenerator
            org.apache.cocoon.generation.ServiceableGenerator
               org.apache.cocoon.generation.XMLDBCollectionGenerator

All Implemented Interfaces:
    CacheableProcessingComponent, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.activity.Initializable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.service.Serviceable, Generator, org.apache.avalon.excalibur.pool.Recyclable, XMLProducer

Deprecated! Use - the XML:DB pseudo protocol instead.

This class implements generation of a XML:DB collection contents as a directory listing.
<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!
Field Summary
protected static final  String URI     
protected static final  String PREFIX     
protected static final  String RESOURCE_COUNT_ATTR     
protected static final  String COLLECTION_COUNT_ATTR     
protected static final  String COLLECTION     
protected static final  String QCOLLECTION     
protected static final  String RESOURCE     
protected static final  String QRESOURCE     
protected  String driver     
protected  String base     
protected  String col     
protected  Database database     
protected  Collection collection     
protected final  AttributesImpl attributes     
Fields inherited from org.apache.cocoon.generation.ServiceableGenerator:
manager
Fields inherited from org.apache.cocoon.generation.AbstractGenerator:
resolver,  objectModel,  parameters,  source
Fields inherited from org.apache.cocoon.xml.AbstractXMLProducer:
EMPTY_CONTENT_HANDLER,  xmlConsumer,  contentHandler,  lexicalHandler
Method from org.apache.cocoon.generation.XMLDBCollectionGenerator Summary:
collectionToSAX,   configure,   generate,   getKey,   getValidity,   initialize,   recycle,   setup
Methods from org.apache.cocoon.generation.ServiceableGenerator:
dispose,   service
Methods from org.apache.cocoon.generation.AbstractGenerator:
recycle,   setup
Methods from org.apache.cocoon.xml.AbstractXMLProducer:
recycle,   setConsumer,   setContentHandler,   setLexicalHandler
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.cocoon.generation.XMLDBCollectionGenerator Detail:
 public  void collectionToSAX(Collection collection) throws SAXException 
      Deprecated!
    Output SAX events listing the collection.
 public  void configure(Configuration conf) throws 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!
 public  void generate() throws IOException, SAXException, ProcessingException 
      Deprecated!
    Parse the requested URI, connect to the XML:DB database and fetch the requested resource.
 public Serializable getKey() 
      Deprecated!
    The component isn't cached (yet)
 public SourceValidity getValidity() 
      Deprecated!
    The component isn't cached (yet)
 public  void initialize() throws Exception 
      Deprecated!
    Initialize the component getting a database instance.
 public  void recycle() 
      Deprecated!
    Recycle the component, keep only the configuration variables and the database instance for reuse.
 public  void setup(SourceResolver resolver,
    Map objectModel,
    String src,
    Parameters par) throws IOException, SAXException, ProcessingException 
      Deprecated!