Package com.adaptris.csv.transform

Class CsvToXmlServiceImpl

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.csv.transform.CsvXmlTransformImpl

com.adaptris.csv.transform.CsvToXmlServiceImpl

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, ConfigComment, MessageEventGenerator, Service, StateManagedComponent

Direct Known Subclasses:

CsvToXml, UncheckedCsvToXml

public abstract class CsvToXmlServiceImpl
extends CsvXmlTransformImpl

Base class for transforming CSV into XML.

Field Summary

Fields inherited from class com.adaptris.csv.transform.CsvXmlTransformImpl

CSV_FIELD_NAME, CSV_RECORD_NAME, XML_ROOT_ELEMENT

Fields inherited from class com.adaptris.core.ServiceImp

log

Constructor Summary

Constructors

Constructor	Description
CsvToXmlServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected Element	addNewElement(Document doc, Element parent, String name)
protected org.supercsv.prefs.CsvPreference	buildPreferences()
protected Node	createTextNode(Document doc, String value)
void	doService(AdaptrisMessage msg)
PreferenceBuilder	getPreferenceBuilder()	How to parse the CSV file.
Boolean	getStripIllegalXmlChars()	Specify whether or not to strip illegal XML characters from all the data before converting to XML.
void	setPreferenceBuilder(PreferenceBuilder preferenceBuilder)	How to parse the CSV file.
void	setStripIllegalXmlChars(Boolean stripIllegalXmlChars)	Specify whether or not to strip illegal XML characters from all the data before converting to XML.
protected boolean	stripIllegalXmlChars()
protected abstract Document	transform(AdaptrisMessage msg)
protected void	writeXmlDocument(Document doc, AdaptrisMessage msg)	Helper method to write the XML document to the AdaptrisMessage taking into account any encoding requirements.

Methods inherited from class com.adaptris.csv.transform.CsvXmlTransformImpl

closeService, evaluateEncoding, getIncludeLineNumberAttribute, getOutputMessageEncoding, includeLineNumberAttribute, initService, prepare, safeElementNames, safeElementNames, setIncludeLineNumberAttribute, setOutputMessageEncoding

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getComments, getContinueOnFail, getIsTrackingEndpoint, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setComments, setContinueOnFail, setIsTrackingEndpoint, setUniqueId, start, stop

Methods inherited from class java.lang.Object

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

Constructor Details

CsvToXmlServiceImpl

public CsvToXmlServiceImpl()

Method Details

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Throws:

ServiceException

transform

protected abstract Document transform(AdaptrisMessage msg)
                               throws ServiceException

Throws:

ServiceException

stripIllegalXmlChars

protected boolean stripIllegalXmlChars()

createTextNode

protected Node createTextNode(Document doc,
 String value)

addNewElement

protected Element addNewElement(Document doc,
 Element parent,
 String name)

writeXmlDocument

protected void writeXmlDocument(Document doc,
 AdaptrisMessage msg)
                         throws Exception

Helper method to write the XML document to the AdaptrisMessage taking into account any encoding requirements.

Parameters:

doc - the XML document

msg - the AdaptrisMessage

Throws:

Exception

buildPreferences

protected org.supercsv.prefs.CsvPreference buildPreferences()

getPreferenceBuilder

public PreferenceBuilder getPreferenceBuilder()

How to parse the CSV file.

setPreferenceBuilder

public void setPreferenceBuilder(PreferenceBuilder preferenceBuilder)

How to parse the CSV file.

getStripIllegalXmlChars

public Boolean getStripIllegalXmlChars()

Specify whether or not to strip illegal XML characters from all the data before converting to XML.

The following regular expression is used to strip out all invalid XML 1.0 characters using XmlHelper.stripIllegalXmlCharacters(String)

See Also:

• XmlHelper.stripIllegalXmlCharacters(String)

setStripIllegalXmlChars

public void setStripIllegalXmlChars(Boolean stripIllegalXmlChars)

Specify whether or not to strip illegal XML characters from all the data before converting to XML.

The following regular expression is used to strip out all invalid XML 1.0 characters using XmlHelper.stripIllegalXmlCharacters(String)

See Also:

• XmlHelper.stripIllegalXmlCharacters(String)