org.apache.camel.model
Class SplitDefinition

java.lang.Object
  org.apache.camel.model.OptionalIdentifiedDefinition
      org.apache.camel.model.ProcessorDefinition<ExpressionNode>
          org.apache.camel.model.ExpressionNode
              org.apache.camel.model.SplitDefinition

All Implemented Interfaces:

Block

public class SplitDefinition
extends ExpressionNode

Represents an XML <split/> element

Version:

$Revision: 887262 $

Field Summary

Fields inherited from class org.apache.camel.model.ProcessorDefinition

errorHandlerBuilder, errorHandlerRef, log

Constructor Summary

SplitDefinition()

SplitDefinition(Expression expression)

SplitDefinition(ExpressionDefinition expression)

Method Summary

SplitDefinition	aggregationStrategy(AggregationStrategy aggregationStrategy) Set the aggregationStrategy
Processor	createProcessor(RouteContext routeContext)
SplitDefinition	executorService(ExecutorService executorService) Setting the executor service for executing the splitting action.
ExpressionClause<SplitDefinition>	expression() Set the expression that the splitter will use
AggregationStrategy	getAggregationStrategy()
ExecutorService	getExecutorService()
String	getLabel() Returns a label to describe this node such as the expression if some kind of expression node
String	getShortName() Returns a short name for this node which can be useful for ID generation or referring to related resources like images
boolean	isParallelProcessing()
Boolean	isStopOnException()
boolean	isStreaming() The splitter should use streaming -- exchanges are being sent as the data for them becomes available.
SplitDefinition	parallelProcessing() Doing the splitting work in parallel
SplitDefinition	parallelProcessing(boolean parallelProcessing) Deprecated. use #parallelProcessing instead
void	setAggregationStrategy(AggregationStrategy aggregationStrategy)
void	setExecutorService(ExecutorService executorService)
void	setParallelProcessing(boolean parallelProcessing)
void	setStopOnException(Boolean stopOnException)
void	setStreaming(boolean streaming)
SplitDefinition	stopOnException() Will now stop further processing if an exception occurred during processing of an Exchange and the caused exception will be thrown.
SplitDefinition	streaming() Enables streaming.
String	toString()

Methods inherited from class org.apache.camel.model.ExpressionNode

createFilterProcessor, getExpression, getOutputs, setExpression, setOutputs

Methods inherited from class org.apache.camel.model.ProcessorDefinition

addInterceptStrategies, addInterceptStrategy, addOutput, addRoutes, aggregate, aggregate, aggregate, aggregate, aggregate, aop, bean, bean, bean, bean, beanRef, beanRef, choice, clearOutput, configureChild, convertBodyTo, convertBodyTo, createChannel, createCompositeProcessor, createErrorHandlerBuilder, createOutputsProcessor, createOutputsProcessor, delay, delay, delay, doTry, end, enrich, enrich, enrichRef, filter, filter, filter, filter, getErrorHandlerBuilder, getInterceptStrategies, getNodeFactory, getParent, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, isAbstract, loadBalance, loadBalance, log, log, log, loop, loop, loop, makeProcessor, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, onCompletion, onException, pipeline, pipeline, pipeline, pipeline, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichRef, process, processRef, recipientList, recipientList, recipientList, removeFaultHeader, removeHeader, removeProperty, resequence, resequence, resequence, resequencer, rollback, rollback, routeId, routingSlip, routingSlip, sample, sample, setBody, setBody, setErrorHandlerBuilder, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setNodeFactory, setOutHeader, setOutHeader, setParent, setProperty, setProperty, sort, sort, sortBody, sortBody, split, split, split, stop, threads, threads, throttle, throwException, to, to, to, to, to, to, to, to, to, to, toAsync, toAsync, toAsync, toAsync, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, wireTap, wireTap, wireTap, wrapChannel, wrapInErrorHandler, wrapProcessor

Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition

description, getDescription, getId, hasCustomIdAssigned, idOrCreate, setDescription, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

SplitDefinition

public SplitDefinition()

SplitDefinition

public SplitDefinition(Expression expression)

SplitDefinition

public SplitDefinition(ExpressionDefinition expression)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getShortName

public String getShortName()

Description copied from class: OptionalIdentifiedDefinition

Returns a short name for this node which can be useful for ID generation or referring to related resources like images

Overrides:

getShortName in class ExpressionNode

Returns:

defaults to "node" but derived nodes should overload this to provide a unique name

getLabel

public String getLabel()

Description copied from class: ProcessorDefinition

Returns a label to describe this node such as the expression if some kind of expression node

Overrides:

getLabel in class ExpressionNode

createProcessor

public Processor createProcessor(RouteContext routeContext)
                          throws Exception

Overrides:

createProcessor in class ProcessorDefinition<ExpressionNode>

Throws:

Exception

expression

public ExpressionClause<SplitDefinition> expression()

Set the expression that the splitter will use

Returns:

the builder

aggregationStrategy

public SplitDefinition aggregationStrategy(AggregationStrategy aggregationStrategy)

Set the aggregationStrategy

Returns:

the builder

parallelProcessing

public SplitDefinition parallelProcessing()

Doing the splitting work in parallel

Returns:

the builder

parallelProcessing

@Deprecated
public SplitDefinition parallelProcessing(boolean parallelProcessing)

Deprecated. use #parallelProcessing instead

Set the splitting action's thread model

Parameters:

parallelProcessing - true to use a thread pool, if false then work is done in the calling thread.

Returns:

the builder

streaming

public SplitDefinition streaming()

Enables streaming. See setStreaming(boolean) for more information

Returns:

the builder

stopOnException

public SplitDefinition stopOnException()

Will now stop further processing if an exception occurred during processing of an Exchange and the caused exception will be thrown.

The default behavior is to not stop but continue processing till the end

Returns:

the builder

executorService

public SplitDefinition executorService(ExecutorService executorService)

Setting the executor service for executing the splitting action.

Parameters:

executorService - the executor service

Returns:

the builder

getAggregationStrategy

public AggregationStrategy getAggregationStrategy()

setAggregationStrategy

public void setAggregationStrategy(AggregationStrategy aggregationStrategy)

isParallelProcessing

public boolean isParallelProcessing()

setParallelProcessing

public void setParallelProcessing(boolean parallelProcessing)

isStreaming

public boolean isStreaming()

The splitter should use streaming -- exchanges are being sent as the data for them becomes available. This improves throughput and memory usage, but it has a drawback: - the sent exchanges will no longer contain the Exchange.SPLIT_SIZE header property

Returns:

whether or not streaming should be used

setStreaming

public void setStreaming(boolean streaming)

isStopOnException

public Boolean isStopOnException()

setStopOnException

public void setStopOnException(Boolean stopOnException)

getExecutorService

public ExecutorService getExecutorService()

setExecutorService

public void setExecutorService(ExecutorService executorService)