com.marklogic.client.datamovement

Interface Splitter<T extends AbstractWriteHandle>

All Known Implementing Classes:

JacksonCSVSplitter, JSONSplitter, LineSplitter, UnarySplitter, XMLSplitter, ZipSplitter

public interface Splitter<T extends AbstractWriteHandle>

Splitter splits an input stream into a Java stream of write handles. It is not thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Splitter.UriMaker UriMaker generates URI for each split file.

Method Summary

Modifier and Type	Method and Description
long	getCount()
java.util.stream.Stream<T>	split(java.io.InputStream input) Converts the incoming input stream to a stream of AbstractWriteHandle objects.
java.util.stream.Stream<DocumentWriteOperation>	splitWriteOperations(java.io.InputStream input) Converts the incoming input stream to a stream of DocumentWriteOperation objects.
java.util.stream.Stream<DocumentWriteOperation>	splitWriteOperations(java.io.InputStream input, java.lang.String splitFilename) Converts the incoming input stream to a stream of DocumentWriteOperation objects.

Method Detail

split

java.util.stream.Stream<T> split(java.io.InputStream input)
                          throws java.lang.Exception

Converts the incoming input stream to a stream of AbstractWriteHandle objects.

Parameters:

input - is the incoming input stream.

Returns:

a stream of AbstractWriteHandle objects.

Throws:

java.lang.Exception - if the input cannot be split

splitWriteOperations

java.util.stream.Stream<DocumentWriteOperation> splitWriteOperations(java.io.InputStream input)
                                                              throws java.lang.Exception

Converts the incoming input stream to a stream of DocumentWriteOperation objects.

Parameters:

input - is the incoming input stream.

Returns:

a stream of DocumentWriteOperation objects.

Throws:

java.lang.Exception - if the input cannot be split

splitWriteOperations

java.util.stream.Stream<DocumentWriteOperation> splitWriteOperations(java.io.InputStream input,
                                                                     java.lang.String splitFilename)
                                                              throws java.lang.Exception

Converts the incoming input stream to a stream of DocumentWriteOperation objects.

Parameters:

input - is the incoming input stream.

splitFilename - the name and extension given to current input file. The names of split files are generated from it.

Returns:

a stream of DocumentWriteOperation objects.

Throws:

java.lang.Exception - if the input cannot be split

getCount

long getCount()

Returns:

the number of objects in the stream.