com.adaptris.core.services.splitter

Class MetadataDocumentCopier

java.lang.Object

com.adaptris.core.services.splitter.MessageSplitterImp

com.adaptris.core.services.splitter.MessageCopier

com.adaptris.core.services.splitter.MetadataDocumentCopier

All Implemented Interfaces:

MessageSplitter

public class MetadataDocumentCopier
extends MessageCopier

Implementation of MessageSplitter which creates multiple instances of the same document based on a metadata key.

The split messages will always contain the entire document, the metadata key containing the number of documents to generate.

In the adapter configuration file this class is aliased as metadata-document-copier which is the preferred alternative to the fully qualified classname when building your configuration.

Nested Class Summary

Nested classes/interfaces inherited from class com.adaptris.core.services.splitter.MessageCopier

MessageCopier.MessageCallback, MessageCopier.MessageCopierIterator

Nested classes/interfaces inherited from class com.adaptris.core.services.splitter.MessageSplitterImp

MessageSplitterImp.SplitMessageIterator

Field Summary

Fields inherited from class com.adaptris.core.services.splitter.MessageSplitterImp

logR

Constructor Summary

Constructors

Constructor and Description
MetadataDocumentCopier()
MetadataDocumentCopier(java.lang.String key)
MetadataDocumentCopier(java.lang.String key, java.lang.String indexKey)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getIndexMetadataKey()
java.lang.String	getMetadataKey()
void	setIndexMetadataKey(java.lang.String s) The metadata key storing the current index of the message from setMetadataKey(String) will be stored (zero based index).
void	setMetadataKey(java.lang.String key) Set the metadata key to use to for generating msgs.
CloseableIterable<AdaptrisMessage>	splitMessage(AdaptrisMessage msg) Splits an AdaptrisMessage into some number of AdaptrisMessage objects.

Methods inherited from class com.adaptris.core.services.splitter.MessageCopier

duplicateWithPayload, toInteger

Methods inherited from class com.adaptris.core.services.splitter.MessageSplitterImp

copyMetadata, getCopyMetadata, getCopyObjectMetadata, getMessageFactory, selectFactory, setCopyMetadata, setCopyObjectMetadata, setMessageFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataDocumentCopier

public MetadataDocumentCopier()

MetadataDocumentCopier

public MetadataDocumentCopier(java.lang.String key)

MetadataDocumentCopier

public MetadataDocumentCopier(java.lang.String key,
                              java.lang.String indexKey)

Method Detail

splitMessage

public CloseableIterable<AdaptrisMessage> splitMessage(AdaptrisMessage msg)
                                                throws CoreException

Description copied from interface: MessageSplitter

Splits an AdaptrisMessage into some number of AdaptrisMessage objects. Preservation of metadata is down to the implementation.

If this method returns a CloseableIterable, it must be closed by the caller! This contract cannot be clearly expressed in Java code without breaking the API in uncomfortable ways for things just returning a List, which is why this method is only declared to return Iterable.

Parameters:

msg - the msg to split

Returns:

an Iterable of AdaptrisMessage

Throws:

CoreException - wrapping any other exception

setMetadataKey

public void setMetadataKey(java.lang.String key)

Set the metadata key to use to for generating msgs.

Parameters:

key - the metadata key

getMetadataKey

public java.lang.String getMetadataKey()

getIndexMetadataKey

public java.lang.String getIndexMetadataKey()

setIndexMetadataKey

public void setIndexMetadataKey(java.lang.String s)

The metadata key storing the current index of the message from setMetadataKey(String) will be stored (zero based index).

Parameters:

s - the index metadata key to set