Chapter 3. Sitemaps

When the pipeline links the components, it merely checks whether the above mentioned interfaces are present. So the pipeline does not know about the specific capabilities or the compatibility of the components. It is the @@ -108,7 +108,7 @@ Our implementation of StAX pipelines uses just StAX interfaces for retrieving events - the writing interface is proprietary in order to avoid multihreading or continuations. So it is really a hybrid process - the StAX component is called to generate the next events, but it is also allowed to read as much data from the previous pipeline component as it wants. But as the produced events are kept in-memory until a later component pulls for them, the components should not emit large amounts of events during one invocation.

import java.io.InputStream; +

import java.io.InputStream;
 import java.net.URL;
 
 import javax.xml.stream.FactoryConfigurationError;
@@ -148,20 +148,20 @@
    public XMLEvent peek() throws XMLStreamException {
       return this.reader.peek();                                                         
    }
-  
-}

- In order to implement an own StAXGenerator the easiest approach is to inherit from AbstractStAXProducer. + +}

	+ In order to implement an own `StAXGenerator` the easiest approach is to inherit from `AbstractStAXProducer`.
	- The constructor creates a new XMLEventReader for reading from the inputstream. + The constructor creates a new XMLEventReader for reading from the inputstream.
	- The pipeline is started using the `execute` method. As StAX is a pull based approach the last component has to start pulling. + The pipeline is started using the `execute` method. As StAX is a pull based approach the last component has to start pulling.
	This method should return true if the generator has a next Event.
	Returns the next event from the generator.
	Returns the next event from the generator, without moving actually to the next event.

2.5.2.2. StAX transformer

Implementing a StAX Transformer should be the most common use case. The AbstractStAXTransformer provides a foundation for new transformers. But in order to write new transformers even simpler, let's describe another feature first:

2.5.2.2.1. Navigator

Navigators allow an easier navigation in the XML document. They also simplify transformers, as usually transformers need only process some parts of the input document and the navigator helps to identify the interesting parts. There are several implementations already included: -

FindStartElementNavigator finds the start tag with certain properties(name,attribute)
FindEndElementNavigator finds the end tag with certain properties(name,attribute)
FindCorrespondingStartEndElementPairNavigator finds both the start and the corresponding end tag.
InSubtreeNavigator finds whole subtrees, by specifying the properties of the "root" element.

- For further information refer to the navigator javadoc -

2.5.2.2.1.1. Using navigators

- Using a navigator is a rather simple task. The transformer peeks or gets the next event and calls Navigator.fulfillsCriteria - if true is returned the transformer should be process that event somehow. -

2.5.2.2.1.2. Implementing a navigator

Creating a new navigator is a rather simple task and just means implementing two methods:

import javax.xml.stream.events.XMLEvent;
+

2.5.2.2. StAX transformer

2.5.2.2.1. Navigator

FindStartElementNavigator finds the start tag with certain properties(name,attribute)
FindEndElementNavigator finds the end tag with certain properties(name,attribute)
FindCorrespondingStartEndElementPairNavigator finds both the start and the corresponding end tag.
InSubtreeNavigator finds whole subtrees, by specifying the properties of the "root" element.

+ For further information refer to the navigator javadoc +

2.5.2.2.1.1. Using navigators

+ Using a navigator is a rather simple task. The transformer peeks or gets the next event and calls Navigator.fulfillsCriteria - if true is returned the transformer should be process that event somehow. +

2.5.2.2.1.2. Implementing a navigator

Creating a new navigator is a rather simple task and just means implementing two methods:

import javax.xml.stream.events.XMLEvent;
 
 public class MyNavigator implements Navigator {
    public boolean fulfillsCriteria(XMLEvent event) {                                     
@@ -172,11 +172,11 @@
       return false;
    }
 }
-

- This method returns true if the event matches the criteria of the navigator. +

	+ This method returns true if the event matches the criteria of the navigator.
	- Returns the result of the last invocation of fulfillsCriteria. -

2.5.2.2.2. Implementing a transformer

The next example should show you an transformer featuring navigators and implicit state handling through function calls.

public class DaisyLinkRewriteTransformer extends AbstractStAXTransformer {
+	      Returns the result of the last invocation of fulfillsCriteria.
+

2.5.2.2.2. Implementing a transformer

The next example should show you an transformer featuring navigators and implicit state handling through function calls.

public class DaisyLinkRewriteTransformer extends AbstractStAXTransformer {
   @Override
    protected void produceEvents() throws XMLStreamException {
       while (this.getParent().hasNext()) {
@@ -270,4 +270,4 @@
 </dependency>

Using woodstox is simpler, as the reference implementation depends on JAXP 1.4, which is not part of Java 1.5. -

2.6. Utilities

TBW: XMLUtils, TransformUtils

Prev	Home	Next
Chapter 1. Introduction	The Apache Cocoon community	Chapter 3. Sitemaps

2.6. Utilities

TBW: XMLUtils, TransformUtils

Prev	Home	Next
Chapter 1. Introduction	The Apache Cocoon community	Chapter 3. Sitemaps

\ No newline at end of file Modified: cocoon/site/site/3.0/reference/html/sitemap.html URL: http://svn.apache.org/viewvc/cocoon/site/site/3.0/reference/html/sitemap.html?rev=898101&r1=898100&r2=898101&view=diff ============================================================================== --- cocoon/site/site/3.0/reference/html/sitemap.html (original) +++ cocoon/site/site/3.0/reference/html/sitemap.html Mon Jan 11 22:47:02 2010 @@ -1,3 +1,3 @@ - Chapter 3. Sitemaps

C hapter 3. Sitemaps

3.1. What is a sitemap?

TBW

3.2. Sitemap evaluation?

TBW

3.3. Expression languages

TBW

3.4. Spring integration

TBW

3.5. Embedding a sitemap

TBW

Prev	Home	Next
Chapter 2. Pipelines	The Apache Cocoon community	Chapter 4. Web applications

+ Chapter 3. Sitemaps

C hapter 3. Sitemaps

3.1. What is a sitemap?

TBW

3.2. Sitemap evaluation?

TBW

3.3. Expression languages

TBW

3.4. Spring integration

TBW

3.5. Embedding a sitemap

TBW

Prev	Home	Next
Chapter 2. Pipelines	The Apache Cocoon community	Chapter 4. Web applications

\ No newline at end of file Modified: cocoon/site/site/3.0/reference/html/webapps.html URL: http://svn.apache.org/viewvc/cocoon/site/site/3.0/reference/html/webapps.html?rev=898101&r1=898100&r2=898101&view=diff ============================================================================== --- cocoon/site/site/3.0/reference/html/webapps.html (original) +++ cocoon/site/site/3.0/reference/html/webapps.html Mon Jan 11 22:47:02 2010 @@ -359,4 +359,4 @@ Operation setCacheValue(String) will set new value of this cache entry.

4.11.2.3.3.2.4. Obtain size of entry

Operation getSize() will return human readable size of current entry. -

4.12. Tutorial

TBW

Prev	Home	Next
Chapter 3. Sitemaps	The Apache Cocoon community	Chapter 5. W icket Integration

4.12. Tutorial

TBW

Prev	Home	Next
Chapter 3. Sitemaps	The Apache Cocoon community	Chapter 5. W icket Integration

\ No newline at end of file Modified: cocoon/site/site/3.0/reference/html/wicket-integration.html URL: http://svn.apache.org/viewvc/cocoon/site/site/3.0/reference/html/wicket-integration.html?rev=898101&r1=898100&r2=898101&view=diff ============================================================================== --- cocoon/site/site/3.0/reference/html/wicket-integration.html (original) +++ cocoon/site/site/3.0/reference/html/wicket-integration.html Mon Jan 11 22:47:02 2010 @@ -170,4 +170,4 @@

The name of the reader is wicket. It's also required to define the base path so that Wicket can calclulate realtive URLs correctly. -

Additionally an XHTML representation of the profiling data should be provided so that the data becomes more readable.

The Team

A successful project requires many people to play many roles. Some members write code or documentation, while others are valuable as testers, submitting patches and suggestions.

The team is comprised of Members and Contributors. Members have direct access to the source of a project and actively evolve the code-base. Contributors improve the project through submission of patches and suggestions to the Members. The number of Contributors to the project is unbounded. Get involved today. All contributions to the project are greatly appreciated.

Members

The following is a list of developers with commit privileges that have directly contributed to the project in one way or another.

Id	Name	Email	Organization	Organization URL	Roles	Time Zone	Actual Time (GMT)
stevendolg	Steven Dolg	stevendolg@apache.org	Indoqa Software Design und Beratung GmbH	http://www.indoqa.com	PMC member, Committer	+1	+1
reinhard	Reinhard Poetz	reinhard@apache.org	Indoqa Software Design und Beratung GmbH	http://www.indoqa.com	ASF member, PMC member, Committer	+1	+1
thorsten	Thorsten Scherler	thorsten@apache.org	-	-	ASF member, PMC member, Committer	+1	+1
cziegeler	Carsten Ziegeler	cziegeler@apache.org	Day Software	http://www.day.com	ASF member, Committer	+1	+1

Contributors

The following additional people have contributed to this project through the way of suggestions, patches or documentation.

Name	Email
Simone Tripodi	simone[dot]tripodi[at]gmail[dot]com
Paul Ercolino	solprovider[at]apache[dot]com
Marc Driftmeyer	mdrift[at]yahoo[dot]com
Andreas Pieber	anpi[at]gmx[dot]at
Jakob Spoerk	jakob[dot]spoerk[at]gmx[d ot]at
Michael Seydl	michael[dot]seydl[at]gmail[dot]com
Kilian Johannes Matt	kilian[dot]matt[at]gmail[dot]com
Michael Handler	michi[dot]handler[at]gmx.at
Christoph Leiter	cleiter[at]gmail.com
Stephan Teuschl	stephan[dot]teuschl[at]gmail.com
Andreas Pinter	pinter[dot]andreas[at]gmail.com
Sebastian Rosensteiner	sebi_rosensteiner[at]gmx.at
Dariusz ?uksza	dariusz[dot]luksza[at]gmail[dot]com
Bertil Chapuis	contact[at]bertil[dot]ch

- + \ No newline at end of file

2.5.1. Available components

2.5.2. Writing custom components

2.5.2.1. StAX generator

2.5.2.2. StAX transformer

2.5.2.2.1. Navigator

2.5.2.2.1.1. Using navigators

2.5.2.2.1.2. Implementing a navigator

2.5.2.2. StAX transformer

2.5.2.2.1. Navigator

2.5.2.2.1.1. Using navigators

2.5.2.2.1.2. Implementing a navigator

2.5.2.2.2. Implementing a transformer

2.5.2.2.2. Implementing a transformer

2.6. Utilities

2.6. Utilities

C hapter 3. Sitemaps

3.1. What is a sitemap?

3.2. Sitemap evaluation?

3.3. Expression languages

3.4. Spring integration

3.5. Embedding a sitemap

C hapter 3. Sitemaps

3.1. What is a sitemap?

3.2. Sitemap evaluation?

3.3. Expression languages

3.4. Spring integration

3.5. Embedding a sitemap

4.11.2.3.3.2.4. Obtain size of entry

4.12. Tutorial

4.12. Tutorial

Implementation ideas

Deliverables

Technologies

Related ideas

Implementation ideas

Deliverables

Technologies

Related ideas

The Team

Members

Contributors