Package com.norconex.importer.handler.splitter.impl

Class XmlStreamSplitterConfig

java.lang.Object

com.norconex.importer.handler.BaseLabelableConfig

com.norconex.importer.handler.BaseDocHandlerConfig

com.norconex.importer.handler.splitter.BaseDocumentSplitterConfig

com.norconex.importer.handler.splitter.impl.XmlStreamSplitterConfig

All Implemented Interfaces:

Labelable

public class XmlStreamSplitterConfig
extends BaseDocumentSplitterConfig

Splits XML document on a specific element.

This class is suited for large XML documents. It will read the XML as a stream and split as it is read, preserving memory during parsing. For this reason, element matching is not as flexible as DOM-based XML parsers, such as DomSplitter, but is more efficient on large documents.

Element matching

To identify the element to split on, you give the full path to it from the document root, where each element is separated by a forward slash. Let's take this XML as an example:

 <animals>
   <species name="mouse">
     <animal>
       <name>Itchy</name>
       <race>cartoon</race>
     </animal>
   </species>
   <species name="cat">
     <animal>
       <name>Scratchy</name>
       <race>cartoon</race>
     </animal>
   </species>
 </animals>
 

To split on <animal>, you would use this path:

 /animals/species/animal
 

Should be used as a pre-parse handler.

Content-types

By default, this filter is restricted to (applies only to) documents matching the restrictions returned by CommonRestrictions.xmlContentTypes(String). You can specify your own restrictions to further narrow, or loosen what documents this splitter applies to.

See Also:

• DomSplitter
• XmlStreamSplitter configuration reference

Constructor Summary

Constructors

Constructor	Description
XmlStreamSplitterConfig()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
TextMatcher	getContentTypeMatcher()	The matcher of content types to apply splitting on.
TextMatcher	getFieldMatcher()	Matcher of one or more fields to use as the source of content to split into new documents, instead of the original document content.
String	getPath()
int	hashCode()
XmlStreamSplitterConfig	setContentTypeMatcher(TextMatcher contentTypeMatcher)	The matcher of content types to apply splitting on.
XmlStreamSplitterConfig	setFieldMatcher(TextMatcher fieldMatcher)
XmlStreamSplitterConfig	setPath(String path)
String	toString()

Methods inherited from class com.norconex.importer.handler.splitter.BaseDocumentSplitterConfig

isDiscardOriginal, setDiscardOriginal

Methods inherited from class com.norconex.importer.handler.BaseLabelableConfig

getLabel, setLabel

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

XmlStreamSplitterConfig

public XmlStreamSplitterConfig()

Method Details

setContentTypeMatcher

public XmlStreamSplitterConfig setContentTypeMatcher(TextMatcher contentTypeMatcher)

The matcher of content types to apply splitting on. No attempt to split documents of any other content types will be made. Default is CommonMatchers.DOM_CONTENT_TYPES.

Parameters:

contentTypeMatcher - content type matcher

Returns:

this

setFieldMatcher

public XmlStreamSplitterConfig setFieldMatcher(TextMatcher fieldMatcher)

getPath

public String getPath()

getContentTypeMatcher

public TextMatcher getContentTypeMatcher()

The matcher of content types to apply splitting on. No attempt to split documents of any other content types will be made. Default is CommonMatchers.DOM_CONTENT_TYPES.

Returns:

content type matcher

getFieldMatcher

public TextMatcher getFieldMatcher()

Matcher of one or more fields to use as the source of content to split into new documents, instead of the original document content.

Returns:

field matcher

setPath

public XmlStreamSplitterConfig setPath(String path)

Returns:

this.

equals

public boolean equals(Object o)

Overrides:

equals in class BaseDocumentSplitterConfig

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class BaseDocumentSplitterConfig

hashCode

public int hashCode()

Overrides:

hashCode in class BaseDocumentSplitterConfig

toString

public String toString()

Overrides:

toString in class BaseDocumentSplitterConfig