org.milyn.csv
Class CSVReader

java.lang.Object
  org.milyn.csv.CSVReader

All Implemented Interfaces:

ContentHandler, VisitorAppender, SmooksXMLReader, org.xml.sax.XMLReader

Direct Known Subclasses:

CSVParser

public class CSVReader
extends java.lang.Object
implements SmooksXMLReader, VisitorAppender

CSV Reader.

This CSV Reader can be plugged into the Smooks (for example) in order to convert a CSV based message stream into a stream of SAX events to be consumed by the DOMBuilder.

Configuration

To maintain a single binding instance in memory:

 <?xml version="1.0"?>
 <smooks-resource-list xmlns="http://www.milyn.org/xsd/smooks-1.1.xsd" xmlns:csv="http://www.milyn.org/xsd/smooks/csv-1.2.xsd">

     <csv:reader fields="" separator="" quote="" skipLines="" rootElementName="" recordElementName="">
         <csv:singleBinding beanId="" class="" />
     </csv:reader>

 </smooks-resource-list>

To maintain a List of binding instances in memory:

 <?xml version="1.0"?>
 <smooks-resource-list xmlns="http://www.milyn.org/xsd/smooks-1.1.xsd" xmlns:csv="http://www.milyn.org/xsd/smooks/csv-1.2.xsd">

     <csv:reader fields="" separator="" quote="" skipLines="" rootElementName="" recordElementName="">
         <csv:listBinding beanId="" class="" />
     </csv:reader>

 </smooks-resource-list>

To maintain a Map of binding instances in memory:

 <?xml version="1.0"?>
 <smooks-resource-list xmlns="http://www.milyn.org/xsd/smooks-1.1.xsd" xmlns:csv="http://www.milyn.org/xsd/smooks/csv-1.2.xsd">

     <csv:reader fields="" separator="" quote="" skipLines="" rootElementName="" recordElementName="">
         <csv:mapBinding beanId="" class="" keyField="" />
     </csv:reader>

 </smooks-resource-list>

Strict parsing

Strict parsing was the only option until Smooks 1.2.x, whereby lines that would not comply with the provided tokens (that it where the tokens present in the line is less than the number of tokens expected) would be garbled and a WARN log statement was provided. Now, you can decide if you want those lines to be parsed too, this is accomplished by setting strict="false" on the config.

String manipulation functions

String manipulation functions can be defined per field. These functions are executed before that the data is converted into SAX events. The functions are defined after the field name, separated with a question mark. So a field definition with string functions could look like this: firstname?trim,lastname?right_trim,gender?upper_case Take a look in the Smooks manual for a list of all available functions.

Ignoring Fields

To ignore a field in a CSV record set, just insert the string "$ignore$" for that field in the fields attribute.

Simple Java Bindings

A simple java binding can be configured on the reader configuration. This allows quick binding configuration where the CSV records map cleanly to the target bean. For more complex bindings, use the Java Binging Framework.

Example Usage

So the following configuration could be used to parse a CSV stream into a stream of SAX events:

 <csv:reader fields="name,address,$ignore$,item,quantity" />

Within Smooks, the stream of SAX events generated by the "Acme-Order-List" message (and this parser) will generate an event stream equivalent to the following:

 <csv-set>
        <csv-record number="1">
                <name>Tom Fennelly</name>
                <address>Ireland</address>
                <item>V1234</item>
                <quantity>3</quantity>
        <csv-record>
        <csv-record number="2">
                <name>Joe Bloggs</name>
                <address>England</address>
                <item>D9123</item>
                <quantity>7</quantity>
        <csv-record>
 </csv-set>

Other profile based transformations can then be used to transform the CSV records in accordance with the requirements of the consuming entities.

Author:

tfennelly

Constructor Summary

CSVReader()

Method Summary

void	addVisitors(VisitorConfigMap visitorMap)
org.xml.sax.ContentHandler	getContentHandler()
org.xml.sax.DTDHandler	getDTDHandler()
org.xml.sax.EntityResolver	getEntityResolver()
org.xml.sax.ErrorHandler	getErrorHandler()
boolean	getFeature(java.lang.String name)
java.lang.Object	getProperty(java.lang.String name)
void	initialize()
void	parse(org.xml.sax.InputSource csvInputSource)
void	parse(java.lang.String systemId) The following methods are currently unimplemnted...
void	setContentHandler(org.xml.sax.ContentHandler contentHandler)
void	setDTDHandler(org.xml.sax.DTDHandler arg0)
void	setEntityResolver(org.xml.sax.EntityResolver arg0)
void	setErrorHandler(org.xml.sax.ErrorHandler arg0)
void	setExecutionContext(ExecutionContext request)
void	setFeature(java.lang.String name, boolean value)
void	setProperty(java.lang.String name, java.lang.Object value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CSVReader

public CSVReader()

Method Detail

initialize

@Initialize
public void initialize()

addVisitors

public void addVisitors(VisitorConfigMap visitorMap)

Specified by:

addVisitors in interface VisitorAppender

setExecutionContext

public void setExecutionContext(ExecutionContext request)

Specified by:

setExecutionContext in interface SmooksXMLReader

parse

public void parse(org.xml.sax.InputSource csvInputSource)
           throws java.io.IOException,
                  org.xml.sax.SAXException

Specified by:

parse in interface org.xml.sax.XMLReader

Throws:

java.io.IOException

org.xml.sax.SAXException

setContentHandler

public void setContentHandler(org.xml.sax.ContentHandler contentHandler)

Specified by:

setContentHandler in interface org.xml.sax.XMLReader

getContentHandler

public org.xml.sax.ContentHandler getContentHandler()

Specified by:

getContentHandler in interface org.xml.sax.XMLReader

parse

public void parse(java.lang.String systemId)
           throws java.io.IOException,
                  org.xml.sax.SAXException

The following methods are currently unimplemnted...

Specified by:

parse in interface org.xml.sax.XMLReader

Throws:

java.io.IOException

org.xml.sax.SAXException

getFeature

public boolean getFeature(java.lang.String name)
                   throws org.xml.sax.SAXNotRecognizedException,
                          org.xml.sax.SAXNotSupportedException

Specified by:

getFeature in interface org.xml.sax.XMLReader

Throws:

org.xml.sax.SAXNotRecognizedException

org.xml.sax.SAXNotSupportedException

setFeature

public void setFeature(java.lang.String name,
                       boolean value)
                throws org.xml.sax.SAXNotRecognizedException,
                       org.xml.sax.SAXNotSupportedException

Specified by:

setFeature in interface org.xml.sax.XMLReader

Throws:

org.xml.sax.SAXNotRecognizedException

org.xml.sax.SAXNotSupportedException

getDTDHandler

public org.xml.sax.DTDHandler getDTDHandler()

Specified by:

getDTDHandler in interface org.xml.sax.XMLReader

setDTDHandler

public void setDTDHandler(org.xml.sax.DTDHandler arg0)

Specified by:

setDTDHandler in interface org.xml.sax.XMLReader

getEntityResolver

public org.xml.sax.EntityResolver getEntityResolver()

Specified by:

getEntityResolver in interface org.xml.sax.XMLReader

setEntityResolver

public void setEntityResolver(org.xml.sax.EntityResolver arg0)

Specified by:

setEntityResolver in interface org.xml.sax.XMLReader

getErrorHandler

public org.xml.sax.ErrorHandler getErrorHandler()

Specified by:

getErrorHandler in interface org.xml.sax.XMLReader

setErrorHandler

public void setErrorHandler(org.xml.sax.ErrorHandler arg0)

Specified by:

setErrorHandler in interface org.xml.sax.XMLReader

getProperty

public java.lang.Object getProperty(java.lang.String name)
                             throws org.xml.sax.SAXNotRecognizedException,
                                    org.xml.sax.SAXNotSupportedException

Specified by:

getProperty in interface org.xml.sax.XMLReader

Throws:

org.xml.sax.SAXNotRecognizedException

org.xml.sax.SAXNotSupportedException

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
                 throws org.xml.sax.SAXNotRecognizedException,
                        org.xml.sax.SAXNotSupportedException

Specified by:

setProperty in interface org.xml.sax.XMLReader

Throws:

org.xml.sax.SAXNotRecognizedException

org.xml.sax.SAXNotSupportedException