nl.nn.adapterframework.extensions.rekenbox

Class Adios2XmlPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.extensions.rekenbox.Adios2XmlPipe

All Implemented Interfaces:

HasTransactionAttribute, IConfigurable, IConfigurationAware, IExtendedPipe, IForwardTarget, INamedObject, IPipe, IScopeProvider, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@Category(value="NN-Special")
public class Adios2XmlPipe
extends FixedForwardPipe

Transforms between ascii-ADIOS and an XML representation of ADIOS.

Sample xml:

 <adios rekenbox="L76HB150">
     <rubriek naam="BER_VERZ_CD" waarde="COMBIFLEX_BELEGGING" />
     <rubriek naam="INBR_CD" waarde="NIEUWE_VERZEKERING" />
     <rubriek naam="PENS_DT_BEP_CD"  waarde="DT_UIT_PENS_LFT" />
     <rubriek nummer="313" naam="AS_OPSL_PRD_TRM_PRM" index="3" recordnr="74" record="VUT_VERZEKERING" waarde="52.34" />
 ...
 </adios>
 

For input, a 'naam' or a 'nummer'-attribute must be specified. If both are specified, their match is checked. On output, 'nummer', 'naam' and 'waarde'-attributes are always present in each rubriek-element. Where applicable 'index', 'recordnr', 'record' and 'recordindex' are present, too. If sub-records exist, they are present with a 'sub' prefix to all attributes.

Author:

Gerrit van Brakel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Adios2XmlPipe.Direction

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	recordIdentifier
protected static String	rubriekIdentifier

Fields inherited from class nl.nn.adapterframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class nl.nn.adapterframework.core.TransactionAttributes

log

Fields inherited from interface nl.nn.adapterframework.core.IExtendedPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor and Description
Adios2XmlPipe()

Method Summary

Modifier and Type	Method and Description
void	addItem(String item, XmlBuilder builder, Map nummer2naam, String naamLabel, String nummerLabel, String indexLabel)
void	configure() checks for correct configuration of forward
PipeRunResult	doPipe(Message message, PipeLineSession session) This is where the action takes place.
String	findRekenbox(PipeLineSession session)
String	getAdiosDefinities()
Adios2XmlPipe.Direction	getDirection()
String	getNoConversionForwardName()
String	getRekenbox()
String	getRekenboxSessionKey()
protected void	initializeConversionTables()
String	makeAdios(InputSource bericht, PipeLineSession session)
String	makeXml(String s, PipeLineSession session) The calcbox tool Adios exports the file "NNRSCONS.PAS" = adiosDefinities in configuration attributes.
void	setAdiosDefinities(String newAdiosDefinities) sets URL to the pascal file with label-constants generated by the ADIOS-utility.
void	setDirection(Adios2XmlPipe.Direction direction) Transformation direction.
void	setNoConversionForwardName(String string) Sets the name of the forward used when no conversion to XML was performed, because the input was already XML.
void	setRekenbox(String newRekenbox) Sets name of the rekenbox to be called
void	setRekenboxSessionKey(String newRekenboxSessionKey) Name of the SessionKey to retrieve the rekenbox name from

Methods inherited from class nl.nn.adapterframework.pipes.FixedForwardPipe

getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class nl.nn.adapterframework.pipes.AbstractPipe

addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, getParameterList, getParameterOverriddenAttributeValue, getParameterValueList, hasSizeStatistics, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, start, stop, throwEvent

Methods inherited from class nl.nn.adapterframework.core.TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.IExtendedPipe

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getLocker, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine

Methods inherited from interface nl.nn.adapterframework.core.IPipe

getMaxThreads

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface nl.nn.adapterframework.core.IForwardTarget

getName

Methods inherited from interface nl.nn.adapterframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Field Detail

recordIdentifier

protected static final String recordIdentifier

See Also:

Constant Field Values

rubriekIdentifier

protected static final String rubriekIdentifier

See Also:

Constant Field Values

Constructor Detail

Adios2XmlPipe

public Adios2XmlPipe()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from class: FixedForwardPipe

checks for correct configuration of forward

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

Overrides:

configure in class FixedForwardPipe

Throws:

ConfigurationException

doPipe

public PipeRunResult doPipe(Message message,
                            PipeLineSession session)
                     throws PipeRunException

Description copied from class: AbstractPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object.

Specified by:

doPipe in interface IPipe

Specified by:

doPipe in class AbstractPipe

Throws:

PipeRunException

initializeConversionTables

protected void initializeConversionTables()
                                   throws ConfigurationException

Throws:

ConfigurationException

findRekenbox

public String findRekenbox(PipeLineSession session)
                    throws PipeRunException

Throws:

PipeRunException

makeAdios

public String makeAdios(InputSource bericht,
                        PipeLineSession session)
                 throws PipeRunException

Throws:

PipeRunException

makeXml

public String makeXml(String s,
                      PipeLineSession session)
               throws PipeRunException

The calcbox tool Adios exports the file "NNRSCONS.PAS" = adiosDefinities in configuration attributes. this file containts both "rubrieken" and "records" which together form the adios message te be send to the calcbox the most difficult format used is record[recordindex],label[index]:waarde; mind the delimiters,where a record has or hasnot an indexnummer and a label likewise.

Throws:

PipeRunException

addItem

public void addItem(String item,
                    XmlBuilder builder,
                    Map nummer2naam,
                    String naamLabel,
                    String nummerLabel,
                    String indexLabel)

setAdiosDefinities

public void setAdiosDefinities(String newAdiosDefinities)

sets URL to the pascal file with label-constants generated by the ADIOS-utility.

Default value

nnrscons.pas

getAdiosDefinities

public String getAdiosDefinities()

setDirection

public void setDirection(Adios2XmlPipe.Direction direction)

Transformation direction.

Default value

Adios2Xml

getDirection

public Adios2XmlPipe.Direction getDirection()

setRekenbox

public void setRekenbox(String newRekenbox)

Sets name of the rekenbox to be called

getRekenbox

public String getRekenbox()

setRekenboxSessionKey

public void setRekenboxSessionKey(String newRekenboxSessionKey)

Name of the SessionKey to retrieve the rekenbox name from

getRekenboxSessionKey

public String getRekenboxSessionKey()

setNoConversionForwardName

public void setNoConversionForwardName(String string)

Sets the name of the forward used when no conversion to XML was performed, because the input was already XML.

Default value

noconversion

getNoConversionForwardName

public String getNoConversionForwardName()