Class LabelFormat

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.extensions.rekenbox.LabelFormat

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

@Category(NN_SPECIAL)
public class LabelFormat
extends FixedForwardPipe

Transforms between ascii and an XML representation.

Sample xml:

<CALCBOXMESSAGE>
		<OPDRACHT>
		    <OPDRACHTSOORT>ONTTREK_RISICO_EN_KOSTEN</OPDRACHTSOORT>
		    <BASISRENDEMENTSOORT>NVT</BASISRENDEMENTSOORT>
		    <BEDRAG>625</BEDRAG>
		    <DATUM>20071201</DATUM>
    ...
</CALCBOXMESSAGE>

Sample ascii:

	OPDRACHT : #SAMENGESTELD
	OPDRACHT.OPDRACHTSOORT :ONTTREK_RISICO_EN_KOSTEN
	OPDRACHT.BASISRENDEMENTSOORT :NVT
	OPDRACHT.BEDRAG :625
	OPDRACHT.DATUM :20071201

         ...
	EINDEREKENVERZOEK :EINDE

Configuration:

attributes	description	default
direction	transformation direction. Possible values "Xml2Label": transform an XML file to ascii "Label2Xml": transform an ascii file to XML	Xml2Label

Author:

Gerrit van Brakel

Field Summary

Fields inherited from class AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class TransactionAttributes

log

Fields inherited from interface IPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor	Description
LabelFormat()

Method Summary

Modifier and Type	Method	Description
@NonNull PipeRunResult	doPipe(Message message, PipeLineSession session)	This is where the action takes place.
String	getDirection()
void	setDirection(String newDirection)	sets transformation direction.

Methods inherited from class FixedForwardPipe

configure, getParameterValue

Methods inherited from class AbstractPipe

addForward, addParameter, createBean, findForward, getAdapter, getEventSourceName, getParameterList, getRegisteredForwards, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDefaultValue, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setIfParam, setIfValue, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setOnlyIfSessionKey, setOnlyIfValue, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setSkipOnEmptyInput, setStoreResultInSessionKey, setUnlessSessionKey, setUnlessValue, setWriteToSecLog, sizeStatisticsEnabled, skipPipe, start, stop, throwEvent

Methods inherited from class TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

Methods inherited from class Object

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

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasName

getName

Methods inherited from interface HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface IForwardTarget

getName

Methods inherited from interface IPipe

getChompCharSize, getDefaultValue, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getIfParam, getIfValue, getLocker, getLogIntermediaryResults, getMaxThreads, getOnlyIfSessionKey, getOnlyIfValue, getSecLogSessionKeys, getStoreResultInSessionKey, getUnlessSessionKey, getUnlessValue, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isSkipOnEmptyInput, isWriteToSecLog, setPipeLine, throwEvent

Constructor Details

LabelFormat

public LabelFormat()

Method Details

doPipe

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

Description copied from interface: IPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult.

Throws:

PipeRunException

setDirection

public void setDirection(String newDirection)

sets transformation direction. Possible values

• "Xml2Label": transform an XML file to ascii
• "Label2Xml": transform an ascii file to XML

default: None

getDirection

public String getDirection()