Package org.ametys.core.cocoon

Class CSVTransformer

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.ametys.core.cocoon.CSVTransformer

All Implemented Interfaces:

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

public class CSVTransformer
extends AbstractTransformer

This transformer is in charge to transform XML to CSV format with escaped and sanitized cell values.
XML input should respect the following format:

     <csv>
          <row>
              <cell>Header 1</cell>
              <cell>Header 2</cell>
              <cell>Header 3</cell>
              <cell>Header 4</cell>
          </row>
          <row>
              <cell>A cell value with "double quotes"</cell>
              <cell></cell>
              <cell>=1+2</cell>
              <cell doNotSanitize="true">=1+2</cell>
          </row>
     </csv>
 

Use do 'doNotSanitize' attribute on tag <cell> to skip sanitization of the cell.
With preceded example, ouput will be:

   "Header 1";"Header 2";"Header 3";"Header 4";
   "A cell value with ""double quotes""";;"'=1+2";"=1+2"
 

Field Summary

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

Constructors

Constructor	Description
CSVTransformer()

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int length)
void	endElement(String uri, String localName, String raw)
void	setup(SourceResolver resolver, Map objectModel, String src, Parameters par)
void	startElement(String uri, String localName, String raw, Attributes atts)

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

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

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

recycle, 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

declaration, endDocument, 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

Constructor Details

CSVTransformer

public CSVTransformer()

Method Details

startElement

public void startElement(String uri,
 String localName,
 String raw,
 Attributes atts)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class AbstractXMLPipe

Throws:

SAXException

characters

public void characters(char[] ch,
 int start,
 int length)
                throws SAXException

Specified by:

characters in interface ContentHandler

Overrides:

characters in class AbstractXMLPipe

Throws:

SAXException

endElement

public void endElement(String uri,
 String localName,
 String raw)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class AbstractXMLPipe

Throws:

SAXException

setup

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

Throws:

ProcessingException

SAXException

IOException