org.apache.cocoon.generation
Class SessionAttributeGenerator

java.lang.Object
  extended byorg.apache.cocoon.util.AbstractLogEnabled
      extended byorg.apache.cocoon.xml.AbstractXMLProducer
          extended byorg.apache.cocoon.generation.AbstractGenerator
              extended byorg.apache.cocoon.generation.SessionAttributeGenerator
All Implemented Interfaces:
org.apache.cocoon.generation.Generator, Poolable, Recyclable, org.apache.cocoon.sitemap.SitemapModelComponent, org.apache.cocoon.xml.XMLProducer

public class SessionAttributeGenerator
extends org.apache.cocoon.generation.AbstractGenerator

Generates a document from a session attribute. Generates a document from a session attribute. The attribute may be a DOM node, an XMLizable, or any other object, and is streamed using the same rules as for <xsp:expr> in XSPs (see org.apache.cocoon.components.language.markup.xsp.XSPObjectHelper).

Name of the session attribute is specified using src attribute of the generate tag, or, if no src tag present, using attr-name parameter.

This generator has 2 parameters:

Example usage :

   <map:generator name="session-attr" logger="sitemap.generator.session-attr"
     src="org.apache.cocoon.generation.SessionAttributeGenerator"/>
   ...
   <map:generate type="session-attr">
     <map:parameter name="attr-name" value="myAttribute"/>
     <map:parameter name="root-element" value="root"/>
   </map:generate>
 

Version:
$Id: SessionAttributeGenerator.html 1304280 2012-03-23 11:18:01Z ilgrosso $
See Also:
ReadDOMSessionTransformer, WriteDOMSessionTransformer

Field Summary
static String ATTR_NAME
           
static String ELEMENT_NAME
           
 
Fields inherited from class org.apache.cocoon.generation.AbstractGenerator
objectModel, parameters, resolver, source
 
Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer
contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer
 
Fields inherited from interface org.apache.cocoon.generation.Generator
ROLE
 
Constructor Summary
SessionAttributeGenerator()
           
 
Method Summary
 void generate()
          Generate XML data
 void setup(org.apache.cocoon.environment.SourceResolver resolver, Map objectModel, String src, Parameters par)
          Setup the file generator :try to retrieve the session attribute given as sitemap parameter
 
Methods inherited from class org.apache.cocoon.generation.AbstractGenerator
recycle
 
Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer
setConsumer, setContentHandler, setLexicalHandler
 
Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled
getLogger, setLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.cocoon.xml.XMLProducer
setConsumer
 

Field Detail

ATTR_NAME

public static final String ATTR_NAME
See Also:
Constant Field Values

ELEMENT_NAME

public static final String ELEMENT_NAME
See Also:
Constant Field Values
Constructor Detail

SessionAttributeGenerator

public SessionAttributeGenerator()
Method Detail

setup

public void setup(org.apache.cocoon.environment.SourceResolver resolver,
                  Map objectModel,
                  String src,
                  Parameters par)
           throws org.apache.cocoon.ProcessingException,
                  SAXException,
                  IOException
Setup the file generator :try to retrieve the session attribute given as sitemap parameter

Throws:
org.apache.cocoon.ProcessingException
SAXException
IOException

generate

public void generate()
              throws IOException,
                     SAXException,
                     org.apache.cocoon.ProcessingException
Generate XML data

Throws:
IOException
SAXException
org.apache.cocoon.ProcessingException


Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.