|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public class XMLDBCollectionGenerator
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 AttributesImpl |
attributes
Deprecated. |
protected String |
base
Deprecated. |
protected String |
col
Deprecated. |
protected org.xmldb.api.base.Collection |
collection
Deprecated. |
protected static String |
COLLECTION
Deprecated. |
protected static String |
COLLECTION_COUNT_ATTR
Deprecated. |
protected org.xmldb.api.base.Database |
database
Deprecated. |
protected String |
driver
Deprecated. |
protected static String |
PREFIX
Deprecated. |
protected static String |
QCOLLECTION
Deprecated. |
protected static String |
QRESOURCE
Deprecated. |
protected static String |
RESOURCE
Deprecated. |
protected static String |
RESOURCE_COUNT_ATTR
Deprecated. |
protected static String |
URI
Deprecated. |
Fields inherited from class org.apache.cocoon.generation.ServiceableGenerator |
---|
manager |
Fields inherited from class org.apache.cocoon.generation.AbstractGenerator |
---|
objectModel, parameters, resolver, source |
Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer |
---|
contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer |
Fields inherited from interface org.apache.cocoon.generation.Generator |
---|
ROLE |
Constructor Summary | |
---|---|
XMLDBCollectionGenerator()
Deprecated. |
Method Summary | |
---|---|
void |
collectionToSAX(org.xmldb.api.base.Collection collection)
Deprecated. Output SAX events listing the collection. |
void |
configure(Configuration conf)
Deprecated. Configure the component. |
void |
generate()
Deprecated. Parse the requested URI, connect to the XML:DB database and fetch the requested resource. |
Serializable |
getKey()
Deprecated. The component isn't cached (yet) |
SourceValidity |
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,
Map objectModel,
String src,
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.ServiceableGenerator |
---|
dispose, service |
Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer |
---|
setConsumer, setContentHandler, setLexicalHandler |
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled |
---|
enableLogging, getLogger, 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 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 org.xmldb.api.base.Database database
protected org.xmldb.api.base.Collection collection
protected final AttributesImpl attributes
Constructor Detail |
---|
public XMLDBCollectionGenerator()
Method Detail |
---|
public void recycle()
recycle
in interface Recyclable
recycle
in class AbstractGenerator
public void configure(Configuration conf) throws 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 Configurable
ConfigurationException
- (configuration invalid or missing)public void initialize() throws Exception
initialize
in interface Initializable
Exception
- if an error occurspublic void setup(SourceResolver resolver, Map objectModel, String src, Parameters par) throws ProcessingException, SAXException, IOException
AbstractGenerator
SourceResolver
, object model Map
,
the source and sitemap Parameters
used to process the request.
setup
in interface SitemapModelComponent
setup
in class AbstractGenerator
ProcessingException
SAXException
IOException
public SourceValidity getValidity()
getValidity
in interface CacheableProcessingComponent
null
if the
component is currently not cacheable.public Serializable getKey()
getKey
in interface CacheableProcessingComponent
null
if the component
is currently not cacheable.public void generate() throws IOException, SAXException, ProcessingException
generate
in interface Generator
ProcessingException
- something unexpected happened with the DB
IOException
SAXException
public void collectionToSAX(org.xmldb.api.base.Collection collection) throws SAXException
SAXException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |