Introduction

Transformers can be placed inside the pipeline between the generator and the serializer. You may have as many transformers as you like. Transformers consume SAX events and emmit SAX events.

The "xslt" transformer is an example of a component with additional configuration.

Overview

The following section presents the transformers available in Cocoon. It was auto-generated from the java source files.

• org.apache.cocoon.transformation.SourceWritingTransformer
• org.apache.cocoon.transformation.TraxTransformer
• org.apache.cocoon.transformation.SQLTransformer
• org.apache.cocoon.transformation.I18nTransformer
• org.apache.cocoon.transformation.CachingCIncludeTransformer
• org.apache.cocoon.transformation.FragmentExtractorTransformer
• org.apache.cocoon.transformation.EncodeURLTransformer
• org.apache.cocoon.transformation.XIncludeTransformer
• org.apache.cocoon.transformation.WriteDOMSessionTransformer
• org.apache.cocoon.transformation.FilterTransformer
• org.apache.cocoon.transformation.XMLDBTransformer
• org.apache.cocoon.transformation.Chart2SvgTransformer
• org.apache.cocoon.transformation.CastorTransformer
• org.apache.cocoon.transformation.LogTransformer
• org.apache.cocoon.transformation.XMLFormTransformer
• org.apache.cocoon.transformation.ReadDOMSessionTransformer
• org.apache.cocoon.transformation.LDAPTransformer
• org.apache.cocoon.transformation.RoleFilterTransformer
• org.apache.cocoon.transformation.XTTransformer
• org.apache.cocoon.transformation.CIncludeTransformer
• org.apache.cocoon.sitemap.LinkTranslator
• org.apache.cocoon.webapps.session.transformation.SessionPreTransformer
• org.apache.cocoon.webapps.session.transformation.SessionPostTransformer
• org.apache.cocoon.webapps.session.transformation.SessionTransformer
• org.apache.cocoon.transformation.pagination.Paginator
• org.apache.cocoon.precept.InstanceTransformer
• org.apache.cocoon.sunshine.transformation.InsertTransformer

org.apache.cocoon.transformation.SourceWritingTransformer

This transformer allows you to output to a WritableSource.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.SourceWritingTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.TraxTransformer

This Transformer is used to transform this incomming SAX stream using a XSLT stylesheet.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.TraxTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.SQLTransformer

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.SQLTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.I18nTransformer

Internationalization transformer is used to transform i18n markup into text based on a particular locale.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.I18nTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.CachingCIncludeTransformer

This transformer triggers for the element include in the namespace "http://apache.org/cocoon/include/1.0".

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.CachingCIncludeTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.FragmentExtractorTransformer

The transformation half of the FragmentExtractor.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.FragmentExtractorTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.EncodeURLTransformer

The encodeURL transformer emits encoded URLs.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="encodeURL " 
    src="org.apache.cocoon.transformation.EncodeURLTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="encodeURL " ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.XIncludeTransformer

My first pass at an XInclude transformation.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.XIncludeTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.WriteDOMSessionTransformer

Make a DOM object from SAX events and write it to the session.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.WriteDOMSessionTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.FilterTransformer

The filter transformer can be used to let only an amount of elements through in a given block.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.FilterTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.XMLDBTransformer

This transformer allows to perform resource creation, deletion, and XUpdate command execution in XML:DB.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.XMLDBTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.Chart2SvgTransformer

This Transformer transforms XML that describes a chart into an SVG representation.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.Chart2SvgTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.CastorTransformer

Description: Marshals a object from the Sitemap, Session, Request or the Conext into a series of SAX events Configuation: The Castortransformer need to be configured with a default mapping.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.CastorTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.LogTransformer

The LogTransformer is a class that can be plugged into a pipeline to print the SAX events which passes thru this transformer in a readable form to a file.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.LogTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.XMLFormTransformer

Transforms a document with XMLForm elements into a document in the same namespace, but with populated values for the XPath references to the form's model attributes The original code was built by Torsten Curdt as part of the Preceptor API

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.XMLFormTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.ReadDOMSessionTransformer

With this transformer, a DOM-object that is stored in the session, can be inserted in the SAX stream at a given position.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.ReadDOMSessionTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.LDAPTransformer

The LDAPTransformer is a class that can be plugged into a pipeline to transform the SAX events which passes thru this transformer into queries an responses to/from a ldap interface.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.LDAPTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.RoleFilterTransformer

Filter XML fragments based on a user's role.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.RoleFilterTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.XTTransformer

This Transformer use the XT processor.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.XTTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.CIncludeTransformer

This transformer triggers for the element include in the namespace "http://apache.org/cocoon/include/1.0".

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.CIncludeTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.sitemap.LinkTranslator

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.sitemap.LinkTranslator"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.webapps.session.transformation.SessionPreTransformer

This is the session pre transformer.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.webapps.session.transformation.SessionPreTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.webapps.session.transformation.SessionPostTransformer

This is the session post transformer.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.webapps.session.transformation.SessionPostTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.webapps.session.transformation.SessionTransformer

This is the session transformer which is only for compatibility.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.webapps.session.transformation.SessionTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.transformation.pagination.Paginator

A paginating transformer.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.transformation.pagination.Paginator"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.precept.InstanceTransformer

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.precept.InstanceTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.sunshine.transformation.InsertTransformer

This implementation allows the inserting of an xml fragment into a resource which is configured in sunConfig.

Overview

Sitemap Definition

Transformer sitemap definition:

<map:transformers default="xslt">
  ...
  <map:transformer name="" 
    src="org.apache.cocoon.sunshine.transformation.InsertTransformer"/>
  ...
</map:transformers>

Sitemap Usage

Transformer usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    ...
    <map:transform type="" ... />
    ...
  </map:match>
  ...
</map:pipeline>