org.apache.cocoon.transformation

This transformer triggers for the element include in the namespace "http://apache.org/cocoon/include/1.0". The src attribute contains the url which points to an xml resource which is include instead of the element. With the attributes element, ns and prefix it is possible to specify an element which surrounds the included content.

Validity of cached pipelines is calculated not by comparing old and new IncludeCacheValidity objects (as in AggregatedCacheValidity) but by comparing timestamps.

A simple transformer including resolvable sources (accessed through Cocoon's SourceResolver ) from its input.

Inclusion is triggered by the <include ...

Example

For instance, if we had an org.apache.cocoon.components.modules.input.XMLFileModule , configured to read values from an XML file:

 <site>
 <faq>
 <how_to_boil_eggs href="faq/eggs.html"/>
 </faq>
 </site>
 

InputModule Configuration

InputModules are configured twice; first statically in cocoon.xconf, and then dynamically at runtime, with dynamic configuration (if any) taking precedence.

A lucene index creation transformer.

This transformer reads a document with elements in the namespace http://apache.org/cocoon/lucene/1.0, and creates a new Lucene Index, or updates an existing one.

It has several parameters which can be set in the sitemap component configuration or as parameters to the transformation step in the pipeline, or finally as attributes of the root element in the source XML document.

It is declared and configured as follows:

 <map:transformers default="...">
 <map:transformer name="sql" src="org.apache.cocoon.transformation.SQLTransformer">
 <old-driver>false</old-driver>
 <connection-attempts>5</connection-attempts>
 <connection-waittime>5000</connection-waittime>
 </map:transformer>
 </map:transformers>
 

It can be used in the sitemap pipeline as follows: <map:transform type="sql"> <map:parameter name="own-connection" value="..."/> <map:parameter name="use-connection" value="..."/> <map:parameter name="dburl" value="..."/> <map:parameter name="username" value="..."/> <map:parameter name="password" value="..."/> <map:parameter name="show-nr-or-rows" value="false"/> <map:parameter name="doc-element" value="rowset"/> <map:parameter name="row-element" value="row"/> <map:parameter name="namespace-uri" value="http://apache.org/cocoon/SQL/2.0"/> <map:parameter name="namespace-prefix" value="sql"/> <map:parameter name="clob-encoding" value=""/> </map:transform>

Transform a5d30250-2b7c-11db-98f0-bef7b2781cf0:en into the corresponding URL.

The ValidationReportTransformer provides a Transformer validating documents while being processed in a Cocoon pipeline, and preparing a report of all detected inconsistancies according the specified schema.

The only defined (but not required) configuration for this component is <grammar>...string...</grammar> indicating the default grammar language of the schemas to use.

This configuration parameter can be overridden by specifying the grammar parameter when using this Transformer in a pipeline.

If no grammar is specified (either as a configuration, or a parameter) this transformer will instruct the Validator to try and guess the grammar of the schema being parsed.

The report prepared by this transformer will look like the following:

 <report xmlns="http://apache.org/cocoon/validation/1.0">
 <warning system="..." public="..." line="..." column="...">
 ...

Example

 <site>
 <faq>
 <how_to_boil_eggs href="faq/eggs.html"/>
 </faq>
 </site>
 

InputModules are configured twice; first statically in cocoon.xconf, and then dynamically at runtime, with dynamic configuration (if any) taking precedence.