CommonConversionContext (DataStax Bulk Loader 1.8.0 API)

java.lang.Object
- com.datastax.oss.dsbulk.codecs.api.ConversionContext
- - com.datastax.oss.dsbulk.codecs.api.CommonConversionContext

Direct Known Subclasses:

TextConversionContext
```
public class CommonConversionContext
extends ConversionContext
```
A collection of most common conversion context attributes used in DSBulk and other projects. These settings can be reused and extended by modules depending on the dsbulk-codec-api module.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALLOW_EXTRA_FIELDS`
`static String`	`ALLOW_MISSING_FIELDS`
`static String`	`BINARY_FORMAT`
`static String`	`BOOLEAN_INPUT_WORDS`
`static String`	`BOOLEAN_NUMBERS`
`static String`	`BOOLEAN_OUTPUT_WORDS`
`static String`	`DATE_PATTERN`
`static String`	`EPOCH`
`static String`	`FORMAT_NUMBERS`
`static String`	`GEO_FORMAT`
`static String`	`LOCAL_DATE_FORMAT`
`static String`	`LOCAL_TIME_FORMAT`
`static String`	`LOCALE`
`static String`	`NULL_STRINGS`
`static String`	`NUMBER_FORMAT`
`static String`	`NUMERIC_PATTERN`
`static String`	`OVERFLOW_STRATEGY`
`static String`	`ROUNDING_MODE`
`static String`	`TIME_PATTERN`
`static String`	`TIME_UNIT`
`static String`	`TIME_UUID_GENERATOR`
`static String`	`TIME_ZONE`
`static String`	`TIMESTAMP_FORMAT`
`static String`	`TIMESTAMP_PATTERN`

Constructor Summary

Constructors
Constructor and Description

CommonConversionContext()

Constructors
Constructor and Description
`CommonConversionContext()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CommonConversionContext`	`setAllowExtraFields(boolean allowExtraFields)`
`CommonConversionContext`	`setAllowMissingFields(boolean allowMissingFields)`
`CommonConversionContext`	`setBinaryFormat(BinaryFormat binaryFormat)` The `BinaryFormat` to use for conversions between `String` and CQL blob.
`CommonConversionContext`	`setBooleanInputWords(Map<String,Boolean> inputWords)` Specify how strings map to `true` and `false`.
`CommonConversionContext`	`setBooleanNumbers(BigDecimal trueNumber, BigDecimal falseNumber)` Sets how numbers are mapped to boolean values.
`CommonConversionContext`	`setBooleanOutputWords(Map<Boolean,String> outputWords)` Specify how `true` and `false` map to strings.
`CommonConversionContext`	`setDateFormat(String dateFormat)` The temporal pattern to use for `String` to CQL `date` conversion.
`CommonConversionContext`	`setEpoch(ZonedDateTime epoch)` This setting applies only to CQL `timestamp` columns, and `USING TIMESTAMP` clauses in queries.
`CommonConversionContext`	`setFormatNumbers(boolean formatNumbers)` Whether or not to use the numeric pattern to format numeric output.
`CommonConversionContext`	`setGeoFormat(GeoFormat binaryFormat)` The `GeoFormat` to use for conversions between `String` and CQL blob.
`CommonConversionContext`	`setLocale(Locale locale)` Sets the locale to use for locale-sensitive conversions.
`CommonConversionContext`	`setNullStrings(List<String> nullStrings)` Comma-separated list of case-sensitive strings that should be mapped to `null`.
`CommonConversionContext`	`setNullStrings(String... nullStrings)` Comma-separated list of case-sensitive strings that should be mapped to `null`.
`CommonConversionContext`	`setNumberFormat(String numberFormat)` The numeric pattern to use for conversions between `String` and CQL numeric types.
`CommonConversionContext`	`setOverflowStrategy(OverflowStrategy overflowStrategy)` The overflow strategy to apply.
`CommonConversionContext`	`setRoundingMode(RoundingMode roundingMode)` The rounding strategy to use for conversions from CQL numeric types to `String`.
`CommonConversionContext`	`setTimeFormat(String timeFormat)` The temporal pattern to use for `String` to CQL `time` conversion.The default is `HH:mm:ss`.
`CommonConversionContext`	`setTimestampFormat(String timestampFormat)` The temporal pattern to use for `String` to CQL `timestamp` conversion.
`CommonConversionContext`	`setTimeUnit(TimeUnit unit)` This setting applies only to CQL `timestamp` columns, and `USING TIMESTAMP` clauses in queries.
`CommonConversionContext`	`setTimeUUIDGenerator(TimeUUIDGenerator uuidGenerator)` Strategy to use when generating time-based (version 1) UUIDs from timestamps.
`CommonConversionContext`	`setTimeZone(ZoneId timeZone)` Sets the time zone to use for temporal conversions.

Methods inherited from class com.datastax.oss.dsbulk.codecs.api.ConversionContext
addAttribute, getAttribute

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOCALE
```
public static final String LOCALE
```
    See Also:
    
    Constant Field Values
  - FORMAT_NUMBERS
```
public static final String FORMAT_NUMBERS
```
    See Also:
    
    Constant Field Values
  - NULL_STRINGS
```
public static final String NULL_STRINGS
```
    See Also:
    
    Constant Field Values
  - NUMERIC_PATTERN
```
public static final String NUMERIC_PATTERN
```
    See Also:
    
    Constant Field Values
  - NUMBER_FORMAT
```
public static final String NUMBER_FORMAT
```
    See Also:
    
    Constant Field Values
  - OVERFLOW_STRATEGY
```
public static final String OVERFLOW_STRATEGY
```
    See Also:
    
    Constant Field Values
  - ROUNDING_MODE
```
public static final String ROUNDING_MODE
```
    See Also:
    
    Constant Field Values
  - TIMESTAMP_PATTERN
```
public static final String TIMESTAMP_PATTERN
```
    See Also:
    
    Constant Field Values
  - DATE_PATTERN
```
public static final String DATE_PATTERN
```
    See Also:
    
    Constant Field Values
  - TIME_PATTERN
```
public static final String TIME_PATTERN
```
    See Also:
    
    Constant Field Values
  - TIMESTAMP_FORMAT
```
public static final String TIMESTAMP_FORMAT
```
    See Also:
    
    Constant Field Values
  - LOCAL_DATE_FORMAT
```
public static final String LOCAL_DATE_FORMAT
```
    See Also:
    
    Constant Field Values
  - LOCAL_TIME_FORMAT
```
public static final String LOCAL_TIME_FORMAT
```
    See Also:
    
    Constant Field Values
  - TIME_ZONE
```
public static final String TIME_ZONE
```
    See Also:
    
    Constant Field Values
  - TIME_UNIT
```
public static final String TIME_UNIT
```
    See Also:
    
    Constant Field Values
  - EPOCH
```
public static final String EPOCH
```
    See Also:
    
    Constant Field Values
  - BOOLEAN_INPUT_WORDS
```
public static final String BOOLEAN_INPUT_WORDS
```
    See Also:
    
    Constant Field Values
  - BOOLEAN_OUTPUT_WORDS
```
public static final String BOOLEAN_OUTPUT_WORDS
```
    See Also:
    
    Constant Field Values
  - BOOLEAN_NUMBERS
```
public static final String BOOLEAN_NUMBERS
```
    See Also:
    
    Constant Field Values
  - TIME_UUID_GENERATOR
```
public static final String TIME_UUID_GENERATOR
```
    See Also:
    
    Constant Field Values
  - BINARY_FORMAT
```
public static final String BINARY_FORMAT
```
    See Also:
    
    Constant Field Values
  - GEO_FORMAT
```
public static final String GEO_FORMAT
```
    See Also:
    
    Constant Field Values
  - ALLOW_EXTRA_FIELDS
```
public static final String ALLOW_EXTRA_FIELDS
```
    See Also:
    
    Constant Field Values
  - ALLOW_MISSING_FIELDS
```
public static final String ALLOW_MISSING_FIELDS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CommonConversionContext
```
public CommonConversionContext()
```
- Method Detail
  - setLocale
```
public CommonConversionContext setLocale(@NonNull
                                         Locale locale)
```
    Sets the locale to use for locale-sensitive conversions. The default is Locale.US.
    
    Returns:
    
    this builder (for method chaining).
  - setTimeZone
```
public CommonConversionContext setTimeZone(@NonNull
                                           ZoneId timeZone)
```
    Sets the time zone to use for temporal conversions. The default is ZoneOffset.UTC.
    When loading, the time zone will be used to obtain a timestamp from inputs that do not convey any explicit time zone information. When unloading, the time zone will be used to format all timestamps.
    
    Returns:
    
    this builder (for method chaining).
  - setFormatNumbers
```
public CommonConversionContext setFormatNumbers(boolean formatNumbers)
```
    Whether or not to use the numeric pattern to format numeric output. The default is false.
    When set to true, numeric pattern will be applied when formatting. This allows for nicely-formatted output, but may result in rounding or alteration of the original decimal's scale. When set to false, numbers will be stringified using the toString() method, and will never result in rounding or scale alteration. Only applicable when unloading, and only if the connector in use requires stringification, because the connector, such as the CSV connector, does not handle raw numeric data; ignored otherwise.
    
    Returns:
    
    this builder (for method chaining).
  - setRoundingMode
```
public CommonConversionContext setRoundingMode(@NonNull
                                               RoundingMode roundingMode)
```
    The rounding strategy to use for conversions from CQL numeric types to String. The default is RoundingMode.UNNECESSARY.
    Only applicable when unloading, if setFormatNumbers(boolean) is true and if the connector in use requires stringification, because the connector, such as the CSV connector, does not handle raw numeric data; ignored otherwise.
    
    Returns:
    
    this builder (for method chaining).
  - setOverflowStrategy
```
public CommonConversionContext setOverflowStrategy(@NonNull
                                                   OverflowStrategy overflowStrategy)
```
    The overflow strategy to apply. See OverflowStrategy javadocs for overflow definitions. The default is OverflowStrategy.REJECT.
    Only applicable for loading, when parsing numeric inputs; it does not apply for unloading, since formatting never results in overflow.
    
    Returns:
    
    this builder (for method chaining).
  - setTimeUnit
```
public CommonConversionContext setTimeUnit(@NonNull
                                           TimeUnit unit)
```
    This setting applies only to CQL timestamp columns, and USING TIMESTAMP clauses in queries. If the input is a string containing only digits that cannot be parsed using the timestamp format, the specified time unit is applied to the parsed value.
    The default is TimeUnit.MILLISECONDS.
    
    Returns:
    
    this builder (for method chaining).
  - setEpoch
```
public CommonConversionContext setEpoch(@NonNull
                                        ZonedDateTime epoch)
```
    This setting applies only to CQL timestamp columns, and USING TIMESTAMP clauses in queries. If the input is a string containing only digits that cannot be parsed using the timestamp format, the specified epoch determines the relative point in time used with the parsed value.
    The default is Instant.EPOCH at ZoneOffset.UTC.
    
    Returns:
    
    this builder (for method chaining).
  - setTimeUUIDGenerator
```
public CommonConversionContext setTimeUUIDGenerator(@NonNull
                                                    TimeUUIDGenerator uuidGenerator)
```
    Strategy to use when generating time-based (version 1) UUIDs from timestamps. The default is TimeUUIDGenerator.RANDOM.
    
    Returns:
    
    this builder (for method chaining).
  - setNumberFormat
```
public CommonConversionContext setNumberFormat(@NonNull
                                               String numberFormat)
```
    The numeric pattern to use for conversions between String and CQL numeric types. The default is #,###.##.
    See DecimalFormat javadocs for details about the pattern syntax to use.
    
    Returns:
    
    this builder (for method chaining).
  - setTimestampFormat
```
public CommonConversionContext setTimestampFormat(@NonNull
                                                  String timestampFormat)
```
    The temporal pattern to use for String to CQL timestamp conversion. The default is CQL_TIMESTAMP.
    Valid choices:
    - A date-time pattern such as yyyy-MM-dd HH:mm:ss
    - A pre-defined formatter such as ISO_ZONED_DATE_TIME or ISO_INSTANT. Any public static field in DateTimeFormatter can be used.
    - The special formatter CQL_TIMESTAMP, which is a special parser that accepts all valid CQL literal formats for the timestamp type.When parsing, this format recognizes all CQL temporal literals; if the input is a local date or date/time, the timestamp is resolved using the time zone specified under timeZone. When formatting, this format uses the ISO_OFFSET_DATE_TIME pattern, which is compliant with both CQL and ISO-8601.
    Returns:
    
    this builder (for method chaining).
  - setDateFormat
```
public CommonConversionContext setDateFormat(@NonNull
                                             String dateFormat)
```
    The temporal pattern to use for String to CQL date conversion. The default is yyyy-MM-dd.
    Valid choices:
    - A date-time pattern such as yyyy-MM-dd.
    - A pre-defined formatter such as ISO_LOCAL_DATE. Any public static field in DateTimeFormatter can be used.
    Returns:
    
    this builder (for method chaining).
  - setTimeFormat
```
public CommonConversionContext setTimeFormat(@NonNull
                                             String timeFormat)
```
    The temporal pattern to use for String to CQL time conversion.The default is HH:mm:ss.
    Valid choices:
    - A date-time pattern, such as HH:mm:ss.
    - A pre-defined formatter, such as ISO_LOCAL_TIME. Any public static field in DateTimeFormatter can be used.
    Returns:
    
    this builder (for method chaining).
  - setBooleanInputWords
```
public CommonConversionContext setBooleanInputWords(@NonNull
                                                    Map<String,Boolean> inputWords)
```
    Specify how strings map to true and false.
    
    Returns:
    
    this builder (for method chaining).
  - setBooleanOutputWords
```
public CommonConversionContext setBooleanOutputWords(@NonNull
                                                     Map<Boolean,String> outputWords)
```
    Specify how true and false map to strings.
    
    Returns:
    
    this builder (for method chaining).
  - setNullStrings
```
public CommonConversionContext setNullStrings(@NonNull
                                              List<String> nullStrings)
```
    Comma-separated list of case-sensitive strings that should be mapped to null.
    For loading, when a record field value exactly matches one of the specified strings, the value is replaced with null before writing to DSE.
    For unloading, this setting is only applicable for string-based connectors, such as the CSV connector: the first string specified will be used to change a row cell containing null to the specified string when written out.
    For example, setting this to ["NULL"] will cause a field containing the word NULL to be mapped to null while loading, and a column containing null to be converted to the word NULL while unloading.
    The default value is [] (no strings are mapped to null). In the default mode, DSBulk behaves as follows: when loading, if the target CQL type is textual (i.e. text, varchar or ascii), the original field value is left untouched; for other types, if the value is an empty string, it is converted to null; when unloading, all null values are converted to an empty string.
    Note that, regardless of this setting, DSBulk will always convert empty strings to null if the target CQL type is not textual (i.e. not text, varchar or ascii).
    
    Returns:
    
    this builder (for method chaining).
  - setNullStrings
```
public CommonConversionContext setNullStrings(@NonNull
                                              String... nullStrings)
```
    Comma-separated list of case-sensitive strings that should be mapped to null.
    For loading, when a record field value exactly matches one of the specified strings, the value is replaced with null before writing to DSE.
    For unloading, this setting is only applicable for string-based connectors, such as the CSV connector: the first string specified will be used to change a row cell containing null to the specified string when written out.
    For example, setting this to ["NULL"] will cause a field containing the word NULL to be mapped to null while loading, and a column containing null to be converted to the word NULL while unloading.
    The default value is [] (no strings are mapped to null). In the default mode, DSBulk behaves as follows: when loading, if the target CQL type is textual (i.e. text, varchar or ascii), the original field value is left untouched; for other types, if the value is an empty string, it is converted to null; when unloading, all null values are converted to an empty string.
    Note that, regardless of this setting, DSBulk will always convert empty strings to null if the target CQL type is not textual (i.e. not text, varchar or ascii).
    
    Returns:
    
    this builder (for method chaining).
  - setBooleanNumbers
```
public CommonConversionContext setBooleanNumbers(@NonNull
                                                 BigDecimal trueNumber,
                                                 BigDecimal falseNumber)
```
    Sets how numbers are mapped to boolean values. The default is BigDecimal.ONE for true andBigDecimal.ZERO for false.
    
    Returns:
    
    this builder (for method chaining).
  - setAllowExtraFields
```
public CommonConversionContext setAllowExtraFields(boolean allowExtraFields)
```
  - setAllowMissingFields
```
public CommonConversionContext setAllowMissingFields(boolean allowMissingFields)
```
  - setBinaryFormat
```
public CommonConversionContext setBinaryFormat(@NonNull
                                               BinaryFormat binaryFormat)
```
    The BinaryFormat to use for conversions between String and CQL blob.
    
    Returns:
    
    this builder (for method chaining).
  - setGeoFormat
```
public CommonConversionContext setGeoFormat(@NonNull
                                            GeoFormat binaryFormat)
```
    The GeoFormat to use for conversions between String and CQL blob.
    
    Returns:
    
    this builder (for method chaining).

Class CommonConversionContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.datastax.oss.dsbulk.codecs.api.ConversionContext

Methods inherited from class java.lang.Object

Field Detail

LOCALE

FORMAT_NUMBERS

NULL_STRINGS

NUMERIC_PATTERN

NUMBER_FORMAT

OVERFLOW_STRATEGY

ROUNDING_MODE

TIMESTAMP_PATTERN

DATE_PATTERN

TIME_PATTERN

TIMESTAMP_FORMAT

LOCAL_DATE_FORMAT

LOCAL_TIME_FORMAT

TIME_ZONE

TIME_UNIT

EPOCH

BOOLEAN_INPUT_WORDS

BOOLEAN_OUTPUT_WORDS

BOOLEAN_NUMBERS

TIME_UUID_GENERATOR

BINARY_FORMAT

GEO_FORMAT

ALLOW_EXTRA_FIELDS

ALLOW_MISSING_FIELDS

Constructor Detail

CommonConversionContext

Method Detail

setLocale

setTimeZone

setFormatNumbers

setRoundingMode

setOverflowStrategy

setTimeUnit

setEpoch

setTimeUUIDGenerator

setNumberFormat

setTimestampFormat

setDateFormat

setTimeFormat

setBooleanInputWords

setBooleanOutputWords

setNullStrings

setNullStrings

setBooleanNumbers

setAllowExtraFields

setAllowMissingFields

setBinaryFormat

setGeoFormat