org.apache.cocoon.transformation
Class AugmentTransformer

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.xml.AbstractXMLProducer
          org.apache.cocoon.xml.AbstractXMLPipe
              org.apache.cocoon.transformation.AbstractTransformer
                  org.apache.cocoon.transformation.AugmentTransformer

All Implemented Interfaces:

Component, ContentHandler, LexicalHandler, LogEnabled, Poolable, Recyclable, SitemapModelComponent, Transformer, XMLConsumer, XMLConsumer, XMLPipe, XMLProducer

public class AugmentTransformer

extends AbstractTransformer

Since:

October 10, 2001

Version:

$Id: AugmentTransformer.java 433543 2006-08-22 06:22:54Z crossley $

Cocoon.sitemap.component.documentation:

Augments all href attributes with the full path to the request. You can optionally specify the mount parameter. The set of attributes to augment can be specified in the attributes parameter (defaults to href if attributes is not present). Any blank character, comma or colon is considered as a separator to delimit attributes.

Cocoon.sitemap.component.logger:

sitemap.transformer.augment

Cocoon.sitemap.component.name:

augment

Field Summary

static String	AUGMENTED_ATTRIBUTES
protected Set	augmentedAttributes
protected String	baseURI
protected Map	objectModel
protected Request	request

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

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.transformation.Transformer

ROLE

Constructor Summary

AugmentTransformer()

Method Summary

void	recycle() Recyclable
void	setup(SourceResolver resolver, Map objectModel, String source, Parameters parameters) Set the SourceResolver, objectModel Map, the source and sitemap Parameters used to process the request.
void	startElement(String uri, String name, String qname, Attributes attrs) Receive notification of the beginning of an element.

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

characters, comment, endCDATA, endDocument, endDTD, endElement, endEntity, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDocument, startDTD, startEntity, startPrefixMapping

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.xml.sax.ContentHandler

characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping

Methods inherited from interface org.xml.sax.ext.LexicalHandler

comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity

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

setConsumer

Field Detail

objectModel

protected Map objectModel

request

protected Request request

baseURI

protected String baseURI

augmentedAttributes

protected Set augmentedAttributes

AUGMENTED_ATTRIBUTES

public static final String AUGMENTED_ATTRIBUTES

See Also:

Constant Field Values

Constructor Detail

AugmentTransformer

public AugmentTransformer()

Method Detail

setup

public void setup(SourceResolver resolver,
                  Map objectModel,
                  String source,
                  Parameters parameters)
           throws ProcessingException,
                  SAXException,
                  IOException

Description copied from interface: SitemapModelComponent

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

Throws:

ProcessingException

SAXException

IOException

startElement

public void startElement(String uri,
                         String name,
                         String qname,
                         Attributes attrs)
                  throws SAXException

Description copied from class: AbstractXMLPipe

Receive notification of the beginning of an element.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class AbstractXMLPipe

Parameters:

uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.

name - The local name (without prefix), or the empty string if Namespace processing is not being performed.

qname - The raw XML 1.0 name (with prefix), or the empty string if raw names are not available.

attrs - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.

Throws:

SAXException

recycle

public void recycle()

Recyclable

Specified by:

recycle in interface Recyclable

Overrides:

recycle in class AbstractXMLProducer