com.cinchapi.concourse.importer.util

Class Importables

Object

Importables

public class Importables
extends Object

Helper functions to aid in the process of importing data from files or strings.

Constructor Summary

Constructors

Constructor and Description
Importables()

Method Summary

Modifier and Type	Method and Description
static String	delimitedStringToJsonArray(String lines, String resolveKey, char delimiter, List<String> header, Transformer transformer) Given a string of lines, where is line has tokens that are separated by a delimiter character, covert each line to a JSON object and return a single string that contains a JSON array of the objects.
static String	delimitedStringToJsonObject(String line, String resolveKey, char delimiter, List<String> header, Transformer transformer) Given a line that is separated by a delimiter character, convert each token to fields within a single JSON object.
static void	delimitedStringToJsonObject(String line, String resolveKey, char delimiter, List<String> header, Transformer transformer, StringBuilder builder) Given a line that is separated by a delimiter character, convert each token to fields within a single JSON object.
static boolean	isValidKeyCharacter(char c) Return true if the specified character is permitted in a key.
protected static void	writeJsonValue(JsonWriter out, String value) Intelligently write the appropriate JSON representation for value to out.

Methods inherited from class Object

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

Constructor Detail

Importables

public Importables()

Method Detail

delimitedStringToJsonArray

public static String delimitedStringToJsonArray(String lines,
                                                @Nullable
                                                String resolveKey,
                                                char delimiter,
                                                List<String> header,
                                                @Nullable
                                                Transformer transformer)

Given a string of lines, where is line has tokens that are separated by a delimiter character, covert each line to a JSON object and return a single string that contains a JSON array of the objects.

Parameters:

lines - the data to convert

resolveKey - a key that the importer uses to determine the existing records into which the data should be imported. The method places the appropriate resolve instruction in the JSON blob so Concourse Server can perform the resolution during the import

delimiter - the delimiter character

header - the list of header keys. If this list is empty, it is assumed that the first line of lines contains the header

transformer - the Transformer that is used to potentially alter key/value pairs before import

Returns:

a JSON string that contains the raw lines in the new format

Throws:

IndexOutOfBoundsException - if a line has more columns that there are header keys; it is fine for a line to have fewer columns that header keys

delimitedStringToJsonObject

@Nullable
public static String delimitedStringToJsonObject(String line,
                                                           @Nullable
                                                           String resolveKey,
                                                           char delimiter,
                                                           List<String> header,
                                                           @Nullable
                                                           Transformer transformer)

Given a line that is separated by a delimiter character, convert each token to fields within a single JSON object.

Parameters:

line - the data to convert

resolveKey - a key that the importer uses to determine the existing records into which the data should be imported. The method places the appropriate resolve instruction in the JSON blob so Concourse Server can perform the resolution during the import

delimiter - the delimiter character

header - the list of header keys. If this list is empty, this method will return null and instead place the tokens from the line into the list

transformer - the Transformer that is used to potentially alter key/value pairs before import

Returns:

a JSON string that contains the raw line in the new format or null if header is empty

Throws:

IndexOutOfBoundsException - if the line has more columns that there are header keys (as long as the number of header keys is > 0); it is fine for a line to have fewer columns that header keys

delimitedStringToJsonObject

public static void delimitedStringToJsonObject(String line,
                                               @Nullable
                                               String resolveKey,
                                               char delimiter,
                                               List<String> header,
                                               @Nullable
                                               Transformer transformer,
                                               StringBuilder builder)

Given a line that is separated by a delimiter character, convert each token to fields within a single JSON object.

This method does not return anything. It writes the JSON blob to the provided builder.

Parameters:

line - the data to convert

resolveKey - a key that the importer uses to determine the existing records into which the data should be imported. The method places the appropriate resolve instruction in the JSON blob so Concourse Server can perform the resolution during the import

delimiter - the delimiter character

header - the list of header keys. If this list is empty, this method will return null and instead place the tokens from the line into the list

transformer - the Transformer that is used to potentially alter key/value pairs before import

builder - the StringBuilder where the JSON blob should be written

Throws:

IndexOutOfBoundsException - if the line has more columns that there are header keys (as long as the number of header keys is > 0); it is fine for a line to have fewer columns that header keys

isValidKeyCharacter

public static boolean isValidKeyCharacter(char c)

Return true if the specified character is permitted in a key.

Parameters:

c - the character to check

Returns:

true if the character is valid, false otherwise

writeJsonValue

protected static void writeJsonValue(JsonWriter out,
                                     String value)
                              throws IOException

Intelligently write the appropriate JSON representation for value to out.

Parameters:

out - the JsonWriter to use for writing

value - the value to write

Throws:

IOException