co.cask.cdap.api.data.format

Class StructuredRecord.Builder

java.lang.Object

co.cask.cdap.api.data.format.StructuredRecord.Builder

Enclosing class:

StructuredRecord

public static class StructuredRecord.Builder
extends Object

Builder for creating a StructuredRecord. TODO: enforce schema correctness?

Method Summary

Modifier and Type	Method and Description
StructuredRecord	build() Build a StructuredRecord with the fields set by this builder.
StructuredRecord.Builder	convertAndSet(String fieldName, Date date) Convert the given date into the type of the given field, and set the value for that field.
StructuredRecord.Builder	convertAndSet(String fieldName, Date date, DateFormat dateFormat) Convert the given date into the type of the given field, and set the value for that field.
StructuredRecord.Builder	convertAndSet(String fieldName, String strVal) Convert the given string into the type of the given field, and set the value for that field.
StructuredRecord.Builder	set(String fieldName, Object value) Set the field to the given value.

Methods inherited from class java.lang.Object

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

Method Detail

set

public StructuredRecord.Builder set(String fieldName,
                                    @Nullable
                                    Object value)

Set the field to the given value.

Parameters:

fieldName - Name of the field to set

value - Value for the field

Returns:

This builder

Throws:

UnexpectedFormatException - if the field is not in the schema, or the field is not nullable but a null value is given

convertAndSet

public StructuredRecord.Builder convertAndSet(String fieldName,
                                              @Nullable
                                              Date date)
                                       throws UnexpectedFormatException

Convert the given date into the type of the given field, and set the value for that field. A Date can be converted into a long or a string.

Parameters:

fieldName - Name of the field to set

date - Date value for the field

Returns:

This builder

Throws:

UnexpectedFormatException - if the field is not in the schema, or the field is not nullable but a null value is given, or the date cannot be converted to the type for the field

convertAndSet

public StructuredRecord.Builder convertAndSet(String fieldName,
                                              @Nullable
                                              Date date,
                                              @Nullable
                                              DateFormat dateFormat)
                                       throws UnexpectedFormatException

Convert the given date into the type of the given field, and set the value for that field. A Date can be converted into a long or a string, using a date format, if supplied.

Parameters:

fieldName - Name of the field to set

date - Date value for the field

dateFormat - Format for the date if it is a string. If null, the default format of "YYYY-MM-DD'T'HH:mm:ss z" will be used

Returns:

This builder

Throws:

UnexpectedFormatException - if the field is not in the schema, or the field is not nullable but a null value is given, or the date cannot be converted to the type for the field

convertAndSet

public StructuredRecord.Builder convertAndSet(String fieldName,
                                              @Nullable
                                              String strVal)
                                       throws UnexpectedFormatException

Convert the given string into the type of the given field, and set the value for that field. A String can be converted to a boolean, int, long, float, double, bytes, string, or null.

Parameters:

fieldName - Name of the field to set

strVal - String value for the field

Returns:

This builder

Throws:

UnexpectedFormatException - if the field is not in the schema, or the field is not nullable but a null value is given, or the string cannot be converted to the type for the field

build

public StructuredRecord build()
                       throws UnexpectedFormatException

Build a StructuredRecord with the fields set by this builder.

Returns:

A StructuredRecord with the fields set by this builder

Throws:

UnexpectedFormatException - if there is at least one non-nullable field without a value