com.boomi.util.json.splitter

Class JsonArraySplitter

java.lang.Object

com.boomi.util.json.splitter.JsonSplitter

com.boomi.util.json.splitter.JsonArraySplitter

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<Payload>

public class JsonArraySplitter
extends JsonSplitter

Implementation of JsonSplitter that splits a json array that is one of the root fields of the document into json object nodes.

It also takes a list of fields to "extract" from the root fields of the document besides the actual list of documents to be splitted, this is normally a "next page token" or similar.

If the json has more than one field with the name of the searched array, only first will be taken in account, the followings fields will be ignored.

This class must be closed in order to free underlying resources.

Constructor Summary

Constructors

Constructor and Description
JsonArraySplitter(InputStream inputStream, String arrayFieldName) Creates a new instance that will search for an array field at the root named arrayFieldName to split.
JsonArraySplitter(InputStream inputStream, String arrayFieldName, boolean failIfArrayFieldNotFound, Set<String> fieldNamesSet, PayloadMetadata metadata) Creates a new instance that will search for an array field at the root named arrayFieldName to split and also try to extract all the fields in fieldNamesSet.
JsonArraySplitter(InputStream inputStream, String arrayFieldName, PayloadMetadata metadata) Creates a new instance that will search for an array field at the root named arrayFieldName to split.
JsonArraySplitter(InputStream inputStream, String arrayFieldName, Set<String> fieldNamesSet) Creates a new instance that will search for an array field at the root named arrayFieldName to split and also try to extract all the fields in fieldNamesSet.
JsonArraySplitter(InputStream inputStream, String arrayFieldName, Set<String> fieldNamesSet, PayloadMetadata metadata) Creates a new instance that will search for an array field at the root named arrayFieldName to split and also try to extract all the fields in fieldNamesSet.

Method Summary

Modifier and Type	Method and Description
protected JsonToken	findNextNodeStart()
JsonNode	getFieldFoundValue(String fieldName) Gets the value of a field that was extracted from the document.
Map<String,JsonNode>	getFieldsFound() Gets a map with all the fields that were extracted from the document.
protected void	initialize()
boolean	wasFieldFound(String fieldName) Validates if a given field was extracted from the document.

Methods inherited from class com.boomi.util.json.splitter.JsonSplitter

close, createGenerator, getParser, iterator, waitForToken, waitForTokens

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

JsonArraySplitter

public JsonArraySplitter(InputStream inputStream,
                         String arrayFieldName)
                  throws IOException

Creates a new instance that will search for an array field at the root named arrayFieldName to split. If the array field is not found trying to iterate will fail.

Parameters:

inputStream - stream that contains the JSON document

arrayFieldName - name of the field at the root that contains the array to split

Throws:

IOException - if there's a problem processing the inputStream

JsonArraySplitter

public JsonArraySplitter(InputStream inputStream,
                         String arrayFieldName,
                         PayloadMetadata metadata)
                  throws IOException

Creates a new instance that will search for an array field at the root named arrayFieldName to split. If the array field is not found trying to iterate will fail.

Parameters:

inputStream - stream that contains the JSON document

arrayFieldName - name of the field at the root that contains the array to split

metadata - include metadata for all the resulting payloads

Throws:

IOException - if there's a problem processing the inputStream

JsonArraySplitter

public JsonArraySplitter(InputStream inputStream,
                         String arrayFieldName,
                         Set<String> fieldNamesSet)
                  throws IOException

Creates a new instance that will search for an array field at the root named arrayFieldName to split and also try to extract all the fields in fieldNamesSet. If the array field is not found trying to iterate will fail.

Parameters:

inputStream - stream that contains the JSON document

arrayFieldName - name of the field at the root that contains the array to split

fieldNamesSet - Set of fields at the root to extract from the JSON document

Throws:

IOException - if there's a problem processing the inputStream

JsonArraySplitter

public JsonArraySplitter(InputStream inputStream,
                         String arrayFieldName,
                         Set<String> fieldNamesSet,
                         PayloadMetadata metadata)
                  throws IOException

Creates a new instance that will search for an array field at the root named arrayFieldName to split and also try to extract all the fields in fieldNamesSet. If the array field is not found trying to iterate will fail.

Parameters:

inputStream - stream that contains the JSON document

arrayFieldName - name of the field at the root that contains the array to split

fieldNamesSet - Set of fields at the root to extract from the JSON document

metadata - include metadata for all the resulting payloads

Throws:

IOException - if there's a problem processing the inputStream

JsonArraySplitter

public JsonArraySplitter(InputStream inputStream,
                         String arrayFieldName,
                         boolean failIfArrayFieldNotFound,
                         Set<String> fieldNamesSet,
                         PayloadMetadata metadata)
                  throws IOException

Creates a new instance that will search for an array field at the root named arrayFieldName to split and also try to extract all the fields in fieldNamesSet.

Parameters:

inputStream - stream that contains the JSON document

arrayFieldName - name of the array field at the root that contains the array to split

failIfArrayFieldNotFound - When arrayFieldName is not found; if true an exception will be thrown. If false the rest of the fields will be processed and no splitting will be done.

fieldNamesSet - Set of fields at the root to extract from the JSON document

metadata - include metadata for all the resulting payloads

Throws:

IOException - if there's a problem processing the inputStream

Method Detail

wasFieldFound

public boolean wasFieldFound(String fieldName)

Validates if a given field was extracted from the document.

The elements must be fully iterated to ensure that the field is found.

Parameters:

fieldName - name of a field that was possibly extracted from the document

Returns:

true if the field was extracted from the document, false if it was not found

getFieldFoundValue

public JsonNode getFieldFoundValue(String fieldName)

Gets the value of a field that was extracted from the document.

The elements must be fully iterated to ensure that the field is found.

Parameters:

fieldName - name of a field that was possibly extracted from the document

Returns:

the value of the field, or null if the field was not found

getFieldsFound

public Map<String,JsonNode> getFieldsFound()

Gets a map with all the fields that were extracted from the document.

The elements must be fully iterated to ensure that all the fields are found.

Returns:

an immutable map with all the fields that were extracted from the document

initialize

protected void initialize()
                   throws IOException

Overrides:

initialize in class JsonSplitter

Throws:

IOException

findNextNodeStart

protected JsonToken findNextNodeStart()
                               throws IOException

Specified by:

findNextNodeStart in class JsonSplitter

Throws:

IOException