Package com.illumon.iris.importers.util

Class JsonImport.Builder

java.lang.Object

com.illumon.iris.importers.util.ImportBuilder<BUILDER_TYPE,IMPORTER_TYPE>

com.illumon.iris.importers.util.FileImportBuilder<JsonImport.Builder,JsonImport>

com.illumon.iris.importers.util.JsonImport.Builder

All Implemented Interfaces:

JsonImportBuilder

Enclosing class:

JsonImport

public static class JsonImport.Builder
extends FileImportBuilder<JsonImport.Builder,JsonImport>
implements JsonImportBuilder

The Builder class allows setting properties for a JSON import and provides a build() method which returns a JsonImport object that will use the configured properties to import batch data.

Field Summary

Fields inherited from class com.illumon.iris.importers.util.FileImportBuilder

sourceDirectory, sourceFile, sourceGlob

Fields inherited from class com.illumon.iris.importers.util.ImportBuilder

destinationDirectory, destinationPartitions, namespace, outputMode, partitionColumn, schemaService, sourceName, strict, table

Constructor Summary

Constructors

Constructor	Description
Builder(String namespace, String table)	Creates the JsonImportBuilder object.

Method Summary

Modifier and Type	Method	Description
JsonImport	build()	Creates a JsonImport object using the properties that have been set in the JsonImport.Builder.
protected JsonImport.Builder	getThis()	Returns this builder.
JsonImport.Builder	setColumnNames(String columnNames)	Sets column names.
JsonImport.Builder	setColumnNames(List<String> columnNames)	Sets column names.
JsonImport.Builder	setConstantColumnValue(String constantColumnValue)	Sets the value to use for source columns with a sourceType of CONSTANT.
JsonImport.Builder	setFieldPathSeparator(String fieldPathSeparator)	Sets a String to use as the separator when generating column names from nested JSON data.
JsonImport.Builder	setMaxInferItems(long maxInferItems)	Sets a limit of the maximum number of JSON objects to examine when inferring which columns are present in the file.

Methods inherited from class com.illumon.iris.importers.util.FileImportBuilder

setSourceDirectory, setSourceDirectory, setSourceFile, setSourceGlob

Methods inherited from class com.illumon.iris.importers.util.ImportBuilder

setDestinationDirectory, setDestinationPartitions, setDestinationPartitions, setOutputMode, setOutputMode, setPartitionColumn, setSchemaService, setSourceName, setStrict

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.illumon.iris.importers.util.JsonImportBuilder

setDestinationDirectory, setDestinationPartitions, setDestinationPartitions, setOutputMode, setOutputMode, setPartitionColumn, setSourceDirectory, setSourceDirectory, setSourceFile, setSourceGlob, setSourceName, setStrict

Constructor Details

Builder

public Builder(String namespace, String table)

Creates the JsonImportBuilder object. Normally accessed through JsonImport.builder(String, String).

Parameters:

namespace - The String name of the namespace into which data will be imported.

table - The String name of the table into which data will be imported.

Method Details

setConstantColumnValue

public JsonImport.Builder setConstantColumnValue(String constantColumnValue)

Sets the value to use for source columns with a sourceType of CONSTANT.

Specified by:

setConstantColumnValue in interface JsonImportBuilder

Parameters:

constantColumnValue - String value for the constant column.

Returns:

this builder.

setMaxInferItems

public JsonImport.Builder setMaxInferItems(long maxInferItems)

Sets a limit of the maximum number of JSON objects to examine when inferring which columns are present in the file. Inference is necessary because JSON has no internal "schema".

Specified by:

setMaxInferItems in interface JsonImportBuilder

Parameters:

maxInferItems - The long value for the limit. Default is no limit.

Returns:

this builder.

setColumnNames

public JsonImport.Builder setColumnNames(String columnNames)

Sets column names.

Specified by:

setColumnNames in interface JsonImportBuilder

Parameters:

columnNames - A comma-separated String of column names in order left to right.

Returns:

this builder.

setColumnNames

public JsonImport.Builder setColumnNames(List<String> columnNames)

Sets column names.

Specified by:

setColumnNames in interface JsonImportBuilder

Parameters:

columnNames - A List of Strings of column names in order left to right.

Returns:

this builder.

setFieldPathSeparator

public JsonImport.Builder setFieldPathSeparator(String fieldPathSeparator)

Sets a String to use as the separator when generating column names from nested JSON data.

Specified by:

setFieldPathSeparator in interface JsonImportBuilder

Parameters:

fieldPathSeparator - A String separator. Default is the underscore character ("_").

Returns:

this builder.

getThis

protected JsonImport.Builder getThis()

Description copied from class: ImportBuilder

Returns this builder. Concrete subclasses mus provide "this" so that the setters can chain properly.

Specified by:

getThis in class ImportBuilder<JsonImport.Builder,JsonImport>

Returns:

this builder.

build

public JsonImport build()

Creates a JsonImport object using the properties that have been set in the JsonImport.Builder.

Specified by:

build in interface JsonImportBuilder

Specified by:

build in class ImportBuilder<JsonImport.Builder,JsonImport>

Returns:

A JsonImport object.