Package org.frankframework.pipes

Class ForEachChildElementPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.MessageSendingPipe

org.frankframework.pipes.IteratingPipe<String>

org.frankframework.pipes.StringIteratorPipe

org.frankframework.pipes.ForEachChildElementPipe

All Implemented Interfaces:

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

@Category(BASIC)
public class ForEachChildElementPipe
extends StringIteratorPipe
implements IThreadCreator

Sends a message to a Sender for each child element of the input XML. The input can be a String containing XML, a filename (set processFile true), an InputStream, or a Reader.

Since:

4.6.1

Author:

Gerrit van Brakel

Parameters

All parameters will be applied to the XSLT if an elementXPathExpression is specified.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ForEachChildElementPipe.SaxAbortException	SAXException thrown to signal that the consumer of a stream does not want to receive more of it.
static class	ForEachChildElementPipe.SaxTimeoutException	SAXException thrown to signal that a timeout occurred in consuming the stream.

Nested classes/interfaces inherited from class org.frankframework.pipes.IteratingPipe

IteratingPipe.ItemCallback, IteratingPipe.StopReason

Nested classes/interfaces inherited from class org.frankframework.pipes.MessageSendingPipe

MessageSendingPipe.LinkMethod

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_XSLT_VERSION

Fields inherited from class org.frankframework.pipes.IteratingPipe

MAX_ITEMS_REACHED_FORWARD, msgTransformerPool, STOP_CONDITION_MET_FORWARD

Fields inherited from class org.frankframework.pipes.MessageSendingPipe

configurationMetrics, INPUT_VALIDATOR_NAME_PREFIX, INPUT_VALIDATOR_NAME_SUFFIX, INPUT_WRAPPER_NAME_PREFIX, INPUT_WRAPPER_NAME_SUFFIX, MAX_RETRY_INTERVAL, MESSAGE_LOG_NAME_PREFIX, MESSAGE_LOG_NAME_SUFFIX, MIN_RETRY_INTERVAL, msgLog, OUTPUT_VALIDATOR_NAME_PREFIX, OUTPUT_VALIDATOR_NAME_SUFFIX, OUTPUT_WRAPPER_NAME_PREFIX, OUTPUT_WRAPPER_NAME_SUFFIX, PIPE_CLEAR_TIMEOUT_MONITOR_EVENT, PIPE_EXCEPTION_MONITOR_EVENT, PIPE_TIMEOUT_MONITOR_EVENT

Fields inherited from class org.frankframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class org.frankframework.core.TransactionAttributes

log

Fields inherited from interface org.frankframework.core.IPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor	Description
ForEachChildElementPipe()

Method Summary

Modifier and Type	Method	Description
void	configure()	Checks for correct configuration of forward.
protected TransformerPool	getExtractElementsTp()
protected IteratingPipe.StopReason	iterateOverInput(Message input, PipeLineSession session, Map<String,Object> threadContext, IteratingPipe<String>.ItemCallback callback)
protected String	makeEncapsulatingXslt(String rootElementName, String xpathExpression, int xsltVersion, String namespaceDefs)
void	setContainerElement(String containerElement)	Element name (not an XPath expression), qualified via attribute namespaceDefs, used to determine the 'root' of elements to be iterated over, i.e., the root of the set of child elements.
void	setElementXPathExpression(String string)	XPath expression used to determine the set of elements to be iterated over, i.e., the set of child elements.
void	setRemoveNamespaces(boolean b)	If true, namespaces (and prefixes) are removed from the items just before forwarding them to the sender.
void	setTargetElement(String targetElement)	Element name (not an XPath expression), qualified via attribute namespaceDefs, used to determine the type of elements to be iterated over, i.e. the element name of each of the child elements.
void	setXsltVersion(int xsltVersion)	If set to 2 or 3, a Saxon (net.sf.saxon) XSLT processor 2.0 or 3.0 will be used, supporting XPath 2.0 or 3.0 respectively.
void	start()	Perform necessary action to start the pipe.
void	stop()	Perform necessary actions to stop the Pipe. For instance, closing JMS connections, DBMS connections etc.

Methods inherited from class org.frankframework.pipes.StringIteratorPipe

createItemCallBack, getKey, setBlockPrefix, setBlockSize, setBlockSuffix, setCombineBlocks, setEndPosition, setEscapeXml, setLinePrefix, setLineSuffix, setStartPosition

Methods inherited from class org.frankframework.pipes.IteratingPipe

getItem, getIterator, getStatisticsKeeper, getStopConditionTp, itemToMessage, sendMessage, setAddInputToResult, setCloseIteratorOnExit, setCollectResults, setIgnoreExceptions, setItemNoSessionKey, setMaxChildThreads, setMaxItems, setNamespaceDefs, setOmitXmlDeclaration, setOutputType, setParallel, setRemoveDuplicates, setRemoveXmlDeclarationInResults, setSender, setStopConditionXPathExpression, setStyleSheetName, setXpathExpression

Methods inherited from class org.frankframework.pipes.MessageSendingPipe

consumesSessionVariable, doLogToMessageLog, doPipe, increaseRetryIntervalAndWait, postSendAction, propagateName, sendMessageWithRetries, setCheckRootTag, setCheckXmlWellFormed, setExceptionOnResult, setHideMethod, setHideRegex, setInputValidator, setInputWrapper, setLinkMethod, setMaxRetries, setMessageLog, setName, setOutputValidator, setOutputWrapper, setPresumedTimeOutInterval, setResultOnTimeOut, setRetryMaxInterval, setRetryMinInterval, setRetryNamespaceDefs, setRetryXPath, setStubFilename, setTimeoutOnResult, setTimeOutOnResult, sizeStatisticsEnabled, storeMessage

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

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

Methods inherited from class org.frankframework.pipes.AbstractPipe

addForward, addParameter, createBean, findForward, getAdapter, getEventSourceName, getForwards, getParameterList, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setLocker, setLogIntermediaryResults, setMaxThreads, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, throwEvent

Methods inherited from class org.frankframework.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 org.frankframework.core.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.HasSender

getSender

Methods inherited from interface org.frankframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface org.frankframework.core.IForwardTarget

getName

Methods inherited from interface org.frankframework.core.IPipe

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

Methods inherited from interface org.frankframework.threading.IThreadCreator

setThreadLifeCycleEventListener

Field Details

DEFAULT_XSLT_VERSION

public static final int DEFAULT_XSLT_VERSION

See Also:

• Constant Field Values

Constructor Details

ForEachChildElementPipe

public ForEachChildElementPipe()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from class: FixedForwardPipe

Checks for correct configuration of forward.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class StringIteratorPipe

Throws:

ConfigurationException - in case it was not able to configure the component.

start

public void start()

Description copied from interface: IPipe

Perform necessary action to start the pipe. This method is executed after the IConfigurable.configure() method, for each start and stop command of the adapter.

Specified by:

start in interface IPipe

Specified by:

start in interface org.springframework.context.Lifecycle

Overrides:

start in class MessageSendingPipe

stop

public void stop()

Description copied from interface: IPipe

Perform necessary actions to stop the Pipe.
For instance, closing JMS connections, DBMS connections etc.

Specified by:

stop in interface IPipe

Specified by:

stop in interface org.springframework.context.Lifecycle

Overrides:

stop in class MessageSendingPipe

makeEncapsulatingXslt

protected String makeEncapsulatingXslt(String rootElementName,
 String xpathExpression,
 int xsltVersion,
 String namespaceDefs)

iterateOverInput

protected IteratingPipe.StopReason iterateOverInput(Message input,
 PipeLineSession session,
 Map<String,Object> threadContext,
 IteratingPipe<String>.ItemCallback callback)
                                             throws SenderException,
TimeoutException

Overrides:

iterateOverInput in class IteratingPipe<String>

Throws:

SenderException

TimeoutException

getExtractElementsTp

protected TransformerPool getExtractElementsTp()

setContainerElement

public void setContainerElement(String containerElement)

Element name (not an XPath expression), qualified via attribute namespaceDefs, used to determine the 'root' of elements to be iterated over, i.e., the root of the set of child elements. When empty, the pipe will iterate over each direct child element of the root.

setTargetElement

public void setTargetElement(String targetElement)

Element name (not an XPath expression), qualified via attribute namespaceDefs, used to determine the type of elements to be iterated over, i.e. the element name of each of the child elements. When empty, the pipe will iterate over any direct child element of the root or specified containerElement.

setElementXPathExpression

public void setElementXPathExpression(String string)

XPath expression used to determine the set of elements to be iterated over, i.e., the set of child elements. When empty, the effective value is \/*\/*, i.e., the pipe will iterate over each direct child element of the root. Be aware that memory consumption appears to increase with file size when this attribute is used. When possible, use containerElement and/or targetElement instead.

setXsltVersion

public void setXsltVersion(int xsltVersion)

If set to 2 or 3, a Saxon (net.sf.saxon) XSLT processor 2.0 or 3.0 will be used, supporting XPath 2.0 or 3.0 respectively. Otherwise, an XSLT processor 1.0 (org.apache.xalan), supporting XPath 1.0, will be used. N.B. Be aware that setting this to a value other than 1 might cause the input file to be read in its entirety into memory, as XSLT Streaming is currently only supported by the XSLT Processor that is used for xsltVersion=1.

Default value

1

setRemoveNamespaces

public void setRemoveNamespaces(boolean b)

If true, namespaces (and prefixes) are removed from the items just before forwarding them to the sender. N.B. This takes place after the transformation for elementXPathExpression if that is specified.