Package com.adaptris.core.services.jdbc

Class MergeResultSetIntoXmlPayload

java.lang.Object

com.adaptris.core.services.jdbc.ResultSetTranslatorBase

com.adaptris.core.services.jdbc.StyledResultTranslatorImp

com.adaptris.core.services.jdbc.ResultSetTranslatorImp

com.adaptris.core.services.jdbc.XmlPayloadTranslatorImpl

com.adaptris.core.services.jdbc.MergeResultSetIntoXmlPayload

All Implemented Interfaces:

ComponentLifecycle, ComponentLifecycleExtension, ResultSetTranslator

public class MergeResultSetIntoXmlPayload
extends XmlPayloadTranslatorImpl

Merge the ResultSet contents into an existing XML Payload.

If you want to see how many rows were processed you can set one/both of the following;

Item	Description	Value
result-count-metadata-item	If set to a String metadata item name will specify the metadata item to contain the number of rows returned by your query	Metadata item name
update-count-metadata-item	If set to a String metadata item name will specify the metadata item to contain the number of rows updated by your SQL statement	Metadata item name

In the adapter configuration file this class is aliased as jdbc-merge-into-xml-payload which is the preferred alternative to the fully qualified classname when building your configuration.

Nested Class Summary

Nested classes/interfaces inherited from class com.adaptris.core.services.jdbc.XmlPayloadTranslatorImpl

XmlPayloadTranslatorImpl.DocumentWrapper

Nested classes/interfaces inherited from class com.adaptris.core.services.jdbc.StyledResultTranslatorImp

StyledResultTranslatorImp.ColumnStyle

Field Summary

Fields inherited from class com.adaptris.core.services.jdbc.XmlPayloadTranslatorImpl

ELEMENT_NAME_COLUMN, ELEMENT_NAME_RESULTS, ELEMENT_NAME_ROW

Fields inherited from class com.adaptris.core.services.jdbc.ResultSetTranslatorBase

log

Constructor Summary

Constructors

Constructor	Description
MergeResultSetIntoXmlPayload()
MergeResultSetIntoXmlPayload(DocumentMerge m)

Method Summary

Modifier and Type	Method	Description
DocumentMerge	getMergeImplementation()
void	setMergeImplementation(DocumentMerge merge)	Set the merge implementation for the resulting document.
long	translateResult(JdbcResult source, AdaptrisMessage target)	Translate the result returning the number of rows translated.

Methods inherited from class com.adaptris.core.services.jdbc.XmlPayloadTranslatorImpl

close, createInputSource, createListFromResultSet, createTextNode, createTransformer, createWrapper, createXmlUtils, getCdataColumnRegexp, getOutputMessageEncoding, getStripIllegalXmlChars, getXmlColumnPrefix, getXmlColumnRegexp, init, isCdataColumn, isXmlColumn, setCdataColumnRegexp, setOutputMessageEncoding, setStripIllegalXmlChars, setXmlColumnPrefix, setXmlColumnRegexp, stripIllegalXmlChars

Methods inherited from class com.adaptris.core.services.jdbc.ResultSetTranslatorImp

addColumnTranslator, getAttemptAutoConvert, getColumnTranslators, getDisplayColumnErrors, getResultCountMetadataItem, getUpdateCountMetadataItem, isDisplayColumnErrors, logColumnErrors, setAttemptAutoConvert, setColumnTranslators, setDisplayColumnErrors, setResultCountMetadataItem, setUpdateCountMetadataItem, toString, translate, updateMetadata, updateMetadataQueryCount, updateMetadataUpdateCount, withAttemptAutoConvert, withColumnTranslators, withColumnTranslators

Methods inherited from class com.adaptris.core.services.jdbc.StyledResultTranslatorImp

getColumnNameStyle, setColumnNameStyle, withColumnNameStyle

Methods inherited from class com.adaptris.core.services.jdbc.ResultSetTranslatorBase

prepare

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.ComponentLifecycle

start, stop

Constructor Detail

MergeResultSetIntoXmlPayload

public MergeResultSetIntoXmlPayload()

MergeResultSetIntoXmlPayload

public MergeResultSetIntoXmlPayload(DocumentMerge m)

Method Detail

translateResult

public long translateResult(JdbcResult source,
                            AdaptrisMessage target)
                     throws java.sql.SQLException,
                            ServiceException

Description copied from class: ResultSetTranslatorImp

Translate the result returning the number of rows translated.

Specified by:

translateResult in class ResultSetTranslatorImp

Throws:

java.sql.SQLException

ServiceException

getMergeImplementation

public DocumentMerge getMergeImplementation()

setMergeImplementation

public void setMergeImplementation(DocumentMerge merge)

Set the merge implementation for the resulting document.

Parameters:

merge -