com.marklogic.client.datamovement

Class XMLSplitter<T extends XMLWriteHandle>

java.lang.Object

com.marklogic.client.datamovement.XMLSplitter<T>

Type Parameters:

T - The type of the handle used for each split payload

All Implemented Interfaces:

Splitter<T>

public class XMLSplitter<T extends XMLWriteHandle>
extends java.lang.Object
implements Splitter<T>

The XMLSplitter is used to split large XML file into separate payloads for writing to the database. For example, large sets of records are often serialized as XML. In particular, relational databases can export a table as an XML file. XMLSplitter could split each row in the large XML file into separate files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMLSplitter.BasicElementVisitor The basic visitor only splits elements with matching element namespace URI and local name.
static interface	XMLSplitter.StartElementReader The StartElementReader is used in visitor to check if the current element is the one to split.
static interface	XMLSplitter.UriMaker UriMaker which generates URI for each split file
static class	XMLSplitter.Visitor<T extends XMLWriteHandle> The Visitor class is used to check if the current element is the target to split.

Constructor Summary

Constructors

Constructor and Description
XMLSplitter(XMLSplitter.Visitor<T> visitor) Construct an XMLSplitter which split the XML file according to the visitor.

Method Summary

Modifier and Type	Method and Description
long	getCount() Returns the number of splits.
XMLSplitter.UriMaker	getUriMaker() Get the UriMaker of the splitter
XMLSplitter.Visitor<T>	getVisitor() Get the visitor used in XMLSplitter class.
static XMLSplitter<StringHandle>	makeSplitter(java.lang.String nsUri, java.lang.String localName) Construct a simple XMLSplitter which split the XML file according to element name.
void	setUriMaker(XMLSplitter.UriMaker uriMaker) Set the UriMaker to the splitter
void	setVisitor(XMLSplitter.Visitor<T> visitor) Set the visitor to select elements to split in XMLSplitter.
java.util.stream.Stream<T>	split(java.io.InputStream input) Takes an input stream of an XML file and split it into a steam of handles.
java.util.stream.Stream<T>	split(javax.xml.stream.XMLStreamReader input) Take an input of XMLStreamReader of the XML file and split it into a stream of handles to write to database.
java.util.stream.Stream<DocumentWriteOperation>	splitWriteOperations(java.io.InputStream input) Takes an input stream of an XML file and split it into a steam of DocumentWriteOperation.
java.util.stream.Stream<DocumentWriteOperation>	splitWriteOperations(java.io.InputStream input, java.lang.String splitFilename) Takes an input stream of an XML file and input file name, split it into a steam of DocumentWriteOperation.
java.util.stream.Stream<DocumentWriteOperation>	splitWriteOperations(javax.xml.stream.XMLStreamReader input, java.lang.String splitFilename) Take an input of XMLStreamReader of the XML file and split it into a stream of DocumentWriteOperations to write to database.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLSplitter

public XMLSplitter(XMLSplitter.Visitor<T> visitor)

Construct an XMLSplitter which split the XML file according to the visitor.

Parameters:

visitor - determines which elements to split

Method Detail

makeSplitter

public static XMLSplitter<StringHandle> makeSplitter(java.lang.String nsUri,
                                                     java.lang.String localName)

Construct a simple XMLSplitter which split the XML file according to element name.

Parameters:

nsUri - The namespace URI of the element

localName - the local name of the element

Returns:

an XMLSplitter which splits each specified element into a separate payloads

getVisitor

public XMLSplitter.Visitor<T> getVisitor()

Get the visitor used in XMLSplitter class.

Returns:

the visitor used in XMLSplitter class

setVisitor

public void setVisitor(XMLSplitter.Visitor<T> visitor)

Set the visitor to select elements to split in XMLSplitter.

Parameters:

visitor - the visitor used in XMLSplitter class

split

public java.util.stream.Stream<T> split(java.io.InputStream input)
                                 throws java.io.IOException,
                                        javax.xml.stream.XMLStreamException

Takes an input stream of an XML file and split it into a steam of handles.

Specified by:

split in interface Splitter<T extends XMLWriteHandle>

Parameters:

input - is the incoming input stream of an XML file

Returns:

a stream of handles to write to database

Throws:

java.io.IOException - if the input cannot be split

javax.xml.stream.XMLStreamException - if there is an error processing the underlying XML source

splitWriteOperations

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

Takes an input stream of an XML file and split it into a steam of DocumentWriteOperation.

Specified by:

splitWriteOperations in interface Splitter<T extends XMLWriteHandle>

Parameters:

input - is the incoming input stream.

Returns:

a stream of DocumentWriteOperation to write to database

Throws:

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

splitWriteOperations

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

Takes an input stream of an XML file and input file name, split it into a steam of DocumentWriteOperation.

Specified by:

splitWriteOperations in interface Splitter<T extends XMLWriteHandle>

Parameters:

input - is the incoming input stream.

splitFilename - is the name of input file, including name and extension. It is used to generate URLs for split files.The splitFilename could either be provided here or in user-defined UriMaker.

Returns:

a stream of DocumentWriteOperation to write to database

Throws:

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

getCount

public long getCount()

Returns the number of splits.

Specified by:

getCount in interface Splitter<T extends XMLWriteHandle>

Returns:

the number of splits

split

public java.util.stream.Stream<T> split(javax.xml.stream.XMLStreamReader input)
                                 throws java.io.IOException

Take an input of XMLStreamReader of the XML file and split it into a stream of handles to write to database.

Parameters:

input - an XMLStreamReader of the XML file

Returns:

a stream of handles to write to database

Throws:

java.io.IOException - if the input cannot be split

splitWriteOperations

public java.util.stream.Stream<DocumentWriteOperation> splitWriteOperations(javax.xml.stream.XMLStreamReader input,
                                                                            java.lang.String splitFilename)

Take an input of XMLStreamReader of the XML file and split it into a stream of DocumentWriteOperations to write to database.

Parameters:

input - an XMLStreamReader of the XML file

splitFilename - is the name of the input file, including name and extension. It is used to generate URLs for split files.The splitFilename could either be provided here or in user-defined UriMaker.

Returns:

a stream of DocumentWriteOperation to write to database

getUriMaker

public XMLSplitter.UriMaker getUriMaker()

Get the UriMaker of the splitter

Returns:

the UriMaker of the splitter

setUriMaker

public void setUriMaker(XMLSplitter.UriMaker uriMaker)

Set the UriMaker to the splitter

Parameters:

uriMaker - the uriMaker to generate URI of each split file.