org.exist.cocoon
Class XMLDBTransformer

java.lang.Object
  AbstractSAXTransformer
      org.exist.cocoon.XMLDBTransformer

public class XMLDBTransformer

extends AbstractSAXTransformer

Transformer component for querying an XML database using the XMLDB API. This component provides a limited set of tags to query collections in the database.

Author:

wolf

See Also:

Serialized Form

Nested Class Summary

protected class

XMLDBTransformer.ForEach

Field Summary

static java.lang.String	COLLECTION_ELEMENT
static java.lang.String	CURRENT_NODE_ELEMENT
java.lang.String	DEFAULT_DRIVER
java.lang.String	DEFAULT_PASSWORD
java.lang.String	DEFAULT_USER
static java.lang.String	ERRMSG_ELEMENT
static java.lang.String	ERROR_ELEMENT
static java.lang.String	FATAL_ERROR
static java.lang.String	FOR_EACH_ELEMENT
static int	IN_COLLECTION
static int	IN_QUERY
static java.lang.String	NAMESPACE
static java.lang.String	PREFIX
static java.lang.String	RESULT_SET_ELEMENT
static java.lang.String	SELECT_NODE
static java.lang.String	STACKTRACE_ELEMENT
static java.lang.String	WARNING

Constructor Summary

XMLDBTransformer()

Method Summary

void	characters(char[] p0, int p1, int p2)
void	configure(Configuration configuration) Try to read configuration parameters from the component setup.
void	endElement(java.lang.String uri, java.lang.String loc, java.lang.String raw)
protected void	endForEach()
void	endPrefixMapping(java.lang.String prefix)
void	recycle()
protected void	reportError(java.lang.String type, java.lang.String message)
protected void	reportError(java.lang.String type, java.lang.String message, java.lang.Exception cause)
void	setup(SourceResolver resolver, java.util.Map map, java.lang.String src, Parameters parameters) Setup the component.
protected void	setupDatabase()
protected void	startCollection(org.xml.sax.Attributes attribs)
protected void	startCurrent(org.xml.sax.Attributes attribs)
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qname, org.xml.sax.Attributes attribs)
protected void	startForEach(org.xml.sax.Attributes attribs)
void	startPrefixMapping(java.lang.String prefix, java.lang.String namespaceURI)
protected void	startSelectNode(org.xml.sax.Attributes attribs)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DRIVER

public java.lang.String DEFAULT_DRIVER

DEFAULT_USER

public java.lang.String DEFAULT_USER

DEFAULT_PASSWORD

public java.lang.String DEFAULT_PASSWORD

NAMESPACE

public static final java.lang.String NAMESPACE

See Also:

Constant Field Values

COLLECTION_ELEMENT

public static final java.lang.String COLLECTION_ELEMENT

See Also:

Constant Field Values

FOR_EACH_ELEMENT

public static final java.lang.String FOR_EACH_ELEMENT

See Also:

Constant Field Values

CURRENT_NODE_ELEMENT

public static final java.lang.String CURRENT_NODE_ELEMENT

See Also:

Constant Field Values

SELECT_NODE

public static final java.lang.String SELECT_NODE

See Also:

Constant Field Values

RESULT_SET_ELEMENT

public static final java.lang.String RESULT_SET_ELEMENT

See Also:

Constant Field Values

ERROR_ELEMENT

public static final java.lang.String ERROR_ELEMENT

See Also:

Constant Field Values

ERRMSG_ELEMENT

public static final java.lang.String ERRMSG_ELEMENT

See Also:

Constant Field Values

STACKTRACE_ELEMENT

public static final java.lang.String STACKTRACE_ELEMENT

See Also:

Constant Field Values

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

FATAL_ERROR

public static final java.lang.String FATAL_ERROR

See Also:

Constant Field Values

WARNING

public static final java.lang.String WARNING

See Also:

Constant Field Values

IN_COLLECTION

public static final int IN_COLLECTION

See Also:

Constant Field Values

IN_QUERY

public static final int IN_QUERY

See Also:

Constant Field Values

Constructor Detail

XMLDBTransformer

public XMLDBTransformer()

Method Detail

setup

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

Setup the component. Accepts parameters "driver", "user" and "password". If specified, those parameters override the default- settings or the settings specified during component setup. Example: <map:transform type="xmldb"> <map:parameter name="driver" value="org.exist.xmldb.DatabaseImpl"/> <map:parameter name="user" value="guest"/> <map:parameter name="password" value="guest"/> </map:transform>

Throws:

ProcessingException

org.xml.sax.SAXException

java.io.IOException

See Also:

org.apache.cocoon.sitemap.SitemapModelComponent#setup(org.apache.cocoon.environment.SourceResolver, java.util.Map, java.lang.String, org.apache.avalon.framework.parameters.Parameters)

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qname,
                         org.xml.sax.Attributes attribs)
                  throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

startCollection

protected void startCollection(org.xml.sax.Attributes attribs)
                        throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

startCurrent

protected void startCurrent(org.xml.sax.Attributes attribs)
                     throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

startSelectNode

protected void startSelectNode(org.xml.sax.Attributes attribs)
                        throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

startForEach

protected void startForEach(org.xml.sax.Attributes attribs)
                     throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

setupDatabase

protected void setupDatabase()
                      throws ProcessingException

Throws:

ProcessingException

reportError

protected void reportError(java.lang.String type,
                           java.lang.String message)
                    throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

reportError

protected void reportError(java.lang.String type,
                           java.lang.String message,
                           java.lang.Exception cause)
                    throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String uri,
                       java.lang.String loc,
                       java.lang.String raw)
                throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

endForEach

protected void endForEach()
                   throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

recycle

public void recycle()

characters

public void characters(char[] p0,
                       int p1,
                       int p2)
                throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Try to read configuration parameters from the component setup. Example: <map:transformer name="xmldb" src="org.exist.cocoon.XMLDBTransformer"> <driver>org.exist.xmldb.DatabaseImpl</driver> <user>guest</user> <password>guest</password> </map:transformer> will set the default driver, user and password. Note that these values may also be set as parameters in the pipeline.

Throws:

ConfigurationException

See Also:

org.apache.avalon.framework.configuration.Configurable#configure(org.apache.avalon.framework.configuration.Configuration)

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String namespaceURI)
                        throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException