|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
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!
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 |
protected java.lang.String driver
protected java.lang.String base
protected java.lang.String col
protected java.lang.String res
protected org.xmldb.api.base.Database database
protected org.xmldb.api.base.Collection collection
protected org.xmldb.api.modules.XMLResource xmlResource
Constructor Detail |
public XMLDBGenerator()
Method Detail |
public void compose(org.apache.avalon.framework.component.ComponentManager manager) throws org.apache.avalon.framework.component.ComponentException
ComposerGenerator
ComponentManager
instance used by this
Composable
.compose
in class ComposerGenerator
public void recycle()
recycle
in class AbstractGenerator
public void configure(org.apache.avalon.framework.configuration.Configuration conf) throws org.apache.avalon.framework.configuration.ConfigurationException
<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!
configure
in interface org.apache.avalon.framework.configuration.Configurable
org.apache.avalon.framework.configuration.ConfigurationException
- (configuration invalid or missing)public void initialize() throws java.lang.Exception
initialize
in interface org.apache.avalon.framework.activity.Initializable
java.lang.Exception
- if an error occurspublic 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
AbstractGenerator
SourceResolver
, object model Map
,
the source and sitemap Parameters
used to process the request.setup
in class AbstractGenerator
public CacheValidity getValidity()
public CacheValidity generateValidity()
generateValidity
in interface Cacheable
org.apache.cocoon.caching.Cacheable
null
if the
component is currently not cacheable.public long generateKey()
generateKey
in interface Cacheable
org.apache.cocoon.caching.Cacheable
0
if the component
is currently not cacheable.public void generate() throws java.io.IOException, org.xml.sax.SAXException, ProcessingException
ProcessingException
- something unexpected happened with the DB
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |