nl.nn.adapterframework.collection

Class CollectorPipe<E extends ICollectingElement<C>,C extends ICollector<E>>

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.stream.StreamingPipe

nl.nn.adapterframework.collection.CollectorPipe<E,C>

Type Parameters:

C -

All Implemented Interfaces:

ICollectingElement<C>, HasTransactionAttribute, IConfigurable, IConfigurationAware, IExtendedPipe, IForwardTarget, INamedObject, IPipe, IScopeProvider, EventThrowing, IOutputStreamingSupport, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

ZipWriterPipe

public abstract class CollectorPipe<E extends ICollectingElement<C>,C extends ICollector<E>>
extends StreamingPipe
implements ICollectingElement<C>

Base class for pipes that combine a number of items.

Author:

Gerrit van Brakel

Field Summary

Fields inherited from class nl.nn.adapterframework.stream.StreamingPipe

AUTOMATIC_STREAMING

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
CollectorPipe()

Method Summary

Modifier and Type	Method and Description
protected boolean	canProvideOutputStream() returns true when: a) the pipe might be able to accept an input by providing an OutputStream, and b) there are no side effects configured that prevent handing over its PipeRunResult to the calling pipe (e.g.
void	configure() checks for correct configuration of forward
PipeRunResult	doPipe(Message input, PipeLineSession session) This is where the action takes place.
CollectionActor.Action	getAction()
String	getCollection()
MessageOutputStream	provideOutputStream(PipeLineSession session) provide the outputstream, or null if a stream cannot be provided.
void	setAction(CollectionActor.Action action)
void	setCollection(String collection)

Methods inherited from class nl.nn.adapterframework.stream.StreamingPipe

canStreamToNextPipe, getNextPipe, getTargetStream, isStreamingActive, provideOutputStream, setStreamingActive, supportsOutputStreamPassThrough

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.collection.ICollectingElement

openCollection

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

Constructor Detail

CollectorPipe

public CollectorPipe()

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 StreamingPipe

Throws:

ConfigurationException

doPipe

public PipeRunResult doPipe(Message input,
                            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

canProvideOutputStream

protected boolean canProvideOutputStream()

Description copied from class: StreamingPipe

returns true when: a) the pipe might be able to accept an input by providing an OutputStream, and b) there are no side effects configured that prevent handing over its PipeRunResult to the calling pipe (e.g. storeResultInSessionKey) c) there are no side effects that require the input to be available at the end of the pipe (e.g. preserveInput=true) d) there are no parameters that require the input value or context (b and c are implemented by PipeProcessors, that do not support outputStreaming)

Overrides:

canProvideOutputStream in class StreamingPipe

provideOutputStream

public MessageOutputStream provideOutputStream(PipeLineSession session)
                                        throws StreamingException

Description copied from class: StreamingPipe

provide the outputstream, or null if a stream cannot be provided. Implementations should provide a forward target by calling StreamingPipe.getNextPipe().

Overrides:

provideOutputStream in class StreamingPipe

Throws:

StreamingException

setAction

public void setAction(CollectionActor.Action action)

getAction

public CollectionActor.Action getAction()

setCollection

public void setCollection(String collection)

getCollection

public String getCollection()