com.cinchapi.etl

Class Transformers

java.lang.Object

com.cinchapi.etl.Transformers

public final class Transformers
extends java.lang.Object

Utilities for import Transformer objects.

Method Summary

Modifier and Type	Method and Description
static Transformer	compose(Transformer... transformers) Return a CompositeTransformer that invokes each of the transformers in order.
static Transformer	composeForEach(Transformer... transformers) Return a CompositeTransformer that wrapers each of the transformers in a forEach(Transformer) transformer} and invokes each of them in order
static Transformer	explode() Return a Transformer that explodes a key/value pair into a nested data structure.
static Transformer	forEach(Transformer transformer) Return a Transformer that will apply the provided transformer to every item in a value that is a sequence or to the value itself if the value is not a sequence.
static Transformer	keyCaseFormat(com.google.common.base.CaseFormat from, com.google.common.base.CaseFormat to) Deprecated. use keyEnsureCaseFormat(CaseFormat) or keyConditionalConvertCaseFormat(CaseFormat, CaseFormat) instead depending on the desired transformation
static Transformer	keyConditionalConvertCaseFormat(com.google.common.base.CaseFormat undesired, com.google.common.base.CaseFormat desired) Return a Transformer that converts a key to a CaseFormat if and only if the key currently matches another undesired format.
static Transformer	keyEnsureCaseFormat(com.google.common.base.CaseFormat format) Return a Transformer that ensures a key is in the specified case format
static Transformer	keyMap(java.util.Map<java.lang.String,java.lang.String> map) Transform keys to other keys using the provided mapping.
static Transformer	keyRemoveInvalidChars(java.util.Collection<java.lang.Character> invalid) Return a Transformer that removes all the character in the invalid collection.
static Transformer	keyRemoveInvalidChars(java.util.function.Predicate<java.lang.Character> invalid) Return a Transformer that removes all characters that match the invalid Predicate from a key.
static Transformer	keyRemoveWhitespace() Return a Transformer that removes all whitespace characters from a key.
static Transformer	keyReplaceChars(java.util.Map<java.lang.Character,java.lang.Character> replacements) Return a Transformer that replaces all the character keys in the replacements mapping with their associated character values in each data key.
static Transformer	keyStripInvalidChars(com.cinchapi.common.base.validate.Check<java.lang.Character> validator) Deprecated. use keyRemoveInvalidChars(Predicate) which takes a Predicate that tests whether a character is invalid. Please note that said functionality is the inverse of this method, which takes a Check that tests whether a character is valid.
static Transformer	keyToLowerCase() Return a Transformer that converts all the characters in a key to lowercase.
static Transformer	keyValueRemoveQuotes() Return a Transformer that will remove single and double quotes from the beginning and end of both the key and value.
static Transformer	keyValueStripQuotes() Deprecated. use keyValueRemoveQuotes() which has the exact same functionality
static Transformer	keyWhitespaceToUnderscore() Return a Transformer that replaces whitespace characters with an underscore in keys.
static Transformer	noOp() Return a Transformer that does not perform any key or value transformations.
static Transformer	nullSafe(Transformer transformer) Return a Transformer that only attempts transformation if the value is not null.
static Transformer	removeValuesThatAre(com.cinchapi.common.describe.Adjective adjective) Deprecated. use instead
static Transformer	valueAsBoolean() Return a Transformer that, For EVERY key, transform values to a Boolean if possible.
static Transformer	valueAsBoolean(java.lang.String... keys) Return a Transformer that, for each of the keys, transform values to a Boolean if possible.
static Transformer	valueAsNumber() Return a Transformer that, For EVERY key, transform values to a Number if possible.
static Transformer	valueAsNumber(java.lang.String... keys) Return a Transformer that, for each of the keys, transform values to a Number if possible.
static Transformer	valueAsResolvableLinkInstruction() Return a Transformer that, For EVERY key, transform values to a resolvable link instruction if possible.
static Transformer	valueAsResolvableLinkInstruction(java.lang.String... keys) Return a Transformer that, for each of the keys, transform values to a resolvable link instruction if possible.
static Transformer	valueAsTag() Return a Transformer that, For EVERY key, transform values to a Number if possible.
static Transformer	valueAsTag(java.lang.String... keys) Return a Transformer that, for each of the keys, transform values to a Tag if possible.
static Transformer	valueAsTimestamp() Return a Transformer that, For EVERY key, transform values to a Timestamp if possible.
static Transformer	valueAsTimestamp(java.lang.String... keys) Return a Transformer that, for each of the keys, transform values to a Timestamp if possible.
static Transformer	valueNullifyIfEmpty() Return a Transformer that replaces a value with null it meets the default definition of Empty.
static Transformer	valueNullifyIfEmpty(com.cinchapi.common.describe.Empty empty) Return a Transformer that replaces a value with null it meets the provided definition of empty.
static Transformer	valueRemoveIf(com.cinchapi.common.describe.Adjective adjective) Return a Transformer that will cause a key/value pair to be "removed" if the value is described by the provided adjective.
static Transformer	valueRemoveIfEmpty()
static Transformer	valueSplitOnDelimiter(char delimiter, com.cinchapi.concourse.util.SplitOption... options) Deprecated. use valueStringSplitOnDelimiter(char, SplitOption...) instead
static Transformer	valueStringSplitOnDelimiter(char delimiter, com.cinchapi.concourse.util.SplitOption... options) Return a Transformer that splits a String value into multiple strings that are all mapped from the original key.
static Transformer	valueStringToJava() Return a Transformer that uses the Convert.stringToJava(String) method to convert String values to the preferred java type.

Methods inherited from class java.lang.Object

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

Method Detail

compose

public static Transformer compose(Transformer... transformers)

Return a CompositeTransformer that invokes each of the transformers in order.

Parameters:

transformers - the transformers to invoke

Returns:

a CompositeTransformer

composeForEach

public static Transformer composeForEach(Transformer... transformers)

Return a CompositeTransformer that wrapers each of the transformers in a forEach(Transformer) transformer} and invokes each of them in order

Parameters:

transformers -

Returns:

a CompositeTransformer

explode

public static Transformer explode()

Return a Transformer that explodes a key/value pair into a nested data structure.

Returns:

the Transformer

forEach

public static Transformer forEach(Transformer transformer)

Return a Transformer that will apply the provided transformer to every item in a value that is a sequence or to the value itself if the value is not a sequence.

NOTE: You should always wrap subsequent transformers within this this one when it is likely that the input values will be collections instead of "flat" objects. For instance, if you have a composite transformation chain and one of the transformers in the sequence is valueSplitOnDelimiter(char, SplitOption...), you should wrap all the following transformers using this method to ensure that the logic is applied to each item.

Parameters:

transformer - the Transformer to apply to every element

Returns:

the Transformer

keyCaseFormat

@Deprecated
public static Transformer keyCaseFormat(com.google.common.base.CaseFormat from,
                                                    com.google.common.base.CaseFormat to)

Deprecated. use keyEnsureCaseFormat(CaseFormat) or keyConditionalConvertCaseFormat(CaseFormat, CaseFormat) instead depending on the desired transformation

Return a Transformer that converts keys from one case format to another one.

Parameters:

from - the original CaseFormat

to - the desired CaseFormat

Returns:

the Transformer

keyConditionalConvertCaseFormat

public static Transformer keyConditionalConvertCaseFormat(com.google.common.base.CaseFormat undesired,
                                                          com.google.common.base.CaseFormat desired)

Return a Transformer that converts a key to a CaseFormat if and only if the key currently matches another undesired format.

This transformer should be use when there is only one case format that is undesirable (e.g. it is fine if a key takes on any other case format). If you want to ensure that a key matches a particular case format, use keyEnsureCaseFormat(CaseFormat).

Parameters:

undesired -

desired -

Returns:

the Transformer

keyEnsureCaseFormat

public static Transformer keyEnsureCaseFormat(com.google.common.base.CaseFormat format)

Return a Transformer that ensures a key is in the specified case format

Parameters:

format -

Returns:

the Transformer

keyMap

public static Transformer keyMap(java.util.Map<java.lang.String,java.lang.String> map)

Transform keys to other keys using the provided mapping.

Parameters:

map -

Returns:

the Transformer

keyWhitespaceToUnderscore

public static Transformer keyWhitespaceToUnderscore()

Return a Transformer that replaces whitespace characters with an underscore in keys.

Returns:

the Transformer

keyRemoveWhitespace

public static Transformer keyRemoveWhitespace()

Return a Transformer that removes all whitespace characters from a key.

Returns:

the Transformer

keyRemoveInvalidChars

public static Transformer keyRemoveInvalidChars(java.util.Collection<java.lang.Character> invalid)

Return a Transformer that removes all the character in the invalid collection.

Parameters:

invalid -

Returns:

the Transformer

keyRemoveInvalidChars

public static Transformer keyRemoveInvalidChars(java.util.function.Predicate<java.lang.Character> invalid)

Return a Transformer that removes all characters that match the invalid Predicate from a key.

Parameters:

invalid -

Returns:

the Transformer

keyReplaceChars

public static Transformer keyReplaceChars(java.util.Map<java.lang.Character,java.lang.Character> replacements)

Return a Transformer that replaces all the character keys in the replacements mapping with their associated character values in each data key.

Parameters:

replacements - a mapping from characters to another character with which it should be replaced

Returns:

the Transformer

keyStripInvalidChars

@Deprecated
public static Transformer keyStripInvalidChars(com.cinchapi.common.base.validate.Check<java.lang.Character> validator)

Deprecated. use keyRemoveInvalidChars(Predicate) which takes a Predicate that tests whether a character is invalid. Please note that said functionality is the inverse of this method, which takes a Check that tests whether a character is valid.

Return a Transformer that strips invalid characters from the key. Some of those characters are replaced with valid stand-ins.

Returns:

the Transformer

keyToLowerCase

public static Transformer keyToLowerCase()

Return a Transformer that converts all the characters in a key to lowercase. No other modifications to the key are made.

Returns:

the Transformer

keyValueRemoveQuotes

public static Transformer keyValueRemoveQuotes()

Return a Transformer that will remove single and double quotes from the beginning and end of both the key and value.

keyValueStripQuotes

@Deprecated
public static Transformer keyValueStripQuotes()

Deprecated. use keyValueRemoveQuotes() which has the exact same functionality

Return a Transformer that will strip single and double quotes from the beginning and end of both the key and value.

noOp

public static Transformer noOp()

Return a Transformer that does not perform any key or value transformations.

Returns:

a no-op Transformer

nullSafe

public static Transformer nullSafe(Transformer transformer)

Return a Transformer that only attempts transformation if the value is not null.

Parameters:

transformer -

Returns:

the Transformer

valueRemoveIfEmpty

public static Transformer valueRemoveIfEmpty()

removeValuesThatAre

@Deprecated
public static Transformer removeValuesThatAre(com.cinchapi.common.describe.Adjective adjective)

Deprecated. use instead

Return a Transformer that will cause a key/value pair to be "removed" if the value is described by the provided adjective.

Removal is accomplished by returning an empty map for the transformation.

Parameters:

adjective -

Returns:

the Transformer

valueRemoveIf

public static Transformer valueRemoveIf(com.cinchapi.common.describe.Adjective adjective)

Return a Transformer that will cause a key/value pair to be "removed" if the value is described by the provided adjective.

Removal is accomplished by returning an empty map for the transformation.

Parameters:

adjective -

Returns:

the Transformer

valueAsBoolean

public static Transformer valueAsBoolean()

Return a Transformer that, For EVERY key, transform values to a Boolean if possible. If the value cannot be transformed, an exception is thrown.

Returns:

the Transformer

valueAsBoolean

public static Transformer valueAsBoolean(java.lang.String... keys)

Return a Transformer that, for each of the keys, transform values to a Boolean if possible. If the value cannot be transformed, an exception is thrown. If keys is an empty array, this transformation is applied to EVERY key (a la valueAsBoolean().

Parameters:

key - the keys for which the transformer is applied

Returns:

the Transformer

valueAsNumber

public static Transformer valueAsNumber()

Return a Transformer that, For EVERY key, transform values to a Number if possible. If the value cannot be transformed, an exception is thrown.

Returns:

the Transformer

valueAsNumber

public static Transformer valueAsNumber(java.lang.String... keys)

Return a Transformer that, for each of the keys, transform values to a Number if possible. If the value cannot be transformed, an exception is thrown. If keys is an empty array, this transformation is applied to EVERY key (a la valueAsNumber().

Parameters:

key - the keys for which the transformer is applied

Returns:

the Transformer

valueAsResolvableLinkInstruction

public static Transformer valueAsResolvableLinkInstruction()

Return a Transformer that, For EVERY key, transform values to a resolvable link instruction if possible. If the value cannot be transformed, an exception is thrown.

Returns:

the Transformer

valueAsResolvableLinkInstruction

public static Transformer valueAsResolvableLinkInstruction(java.lang.String... keys)

Return a Transformer that, for each of the keys, transform values to a resolvable link instruction if possible. If the value cannot be transformed, an exception is thrown. If keys is an empty array, this transformation is applied to EVERY key (a la valueAsResolvableLinkInstruction().

Parameters:

key - the keys for which the transformer is applied

Returns:

the Transformer

valueAsTag

public static Transformer valueAsTag()

Return a Transformer that, For EVERY key, transform values to a Number if possible. If the value cannot be transformed, an exception is thrown.

Returns:

the Transformer

valueAsTag

public static Transformer valueAsTag(java.lang.String... keys)

Return a Transformer that, for each of the keys, transform values to a Tag if possible. If the value cannot be transformed, an exception is thrown. If keys is an empty array, this transformation is applied to EVERY key (a la valueAsTag().

Parameters:

key - the keys for which the transformer is applied

Returns:

the Transformer

valueAsTimestamp

public static Transformer valueAsTimestamp()

Return a Transformer that, For EVERY key, transform values to a Timestamp if possible. If the value cannot be transformed, an exception is thrown.

Returns:

the Transformer

valueAsTimestamp

public static Transformer valueAsTimestamp(java.lang.String... keys)

Return a Transformer that, for each of the keys, transform values to a Timestamp if possible. If the value cannot be transformed, an exception is thrown. If keys is an empty array, this transformation is applied to EVERY key (a la valueAsTimestamp().

Parameters:

key - the keys for which the transformer is applied

Returns:

the Transformer

valueNullifyIfEmpty

public static Transformer valueNullifyIfEmpty()

Return a Transformer that replaces a value with null it meets the default definition of Empty.

Returns:

the Transformer

valueNullifyIfEmpty

public static Transformer valueNullifyIfEmpty(com.cinchapi.common.describe.Empty empty)

Return a Transformer that replaces a value with null it meets the provided definition of empty.

Parameters:

empty -

Returns:

the Transformer

valueSplitOnDelimiter

@Deprecated
public static Transformer valueSplitOnDelimiter(char delimiter,
                                                            com.cinchapi.concourse.util.SplitOption... options)

Deprecated. use valueStringSplitOnDelimiter(char, SplitOption...) instead

Return a Transformer that splits a String value into multiple strings that are all mapped from the original key.

Parameters:

delimiter - the character on which to split the String

options - the optional SplitOptions

Returns:

the Transformer

valueStringSplitOnDelimiter

public static Transformer valueStringSplitOnDelimiter(char delimiter,
                                                      com.cinchapi.concourse.util.SplitOption... options)

Return a Transformer that splits a String value into multiple strings that are all mapped from the original key.

Parameters:

delimiter - the character on which to split the String

options - the optional SplitOptions

Returns:

the Transformer

valueStringToJava

public static Transformer valueStringToJava()

Return a Transformer that uses the Convert.stringToJava(String) method to convert String values to the preferred java type. If the value is not a String, this transformer has no effect.

Returns:

the Transformer