com.yahoo.bullet.dsl.converter

Class BulletRecordConverter

java.lang.Object

com.yahoo.bullet.dsl.converter.BulletRecordConverter

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AvroBulletRecordConverter, MapBulletRecordConverter, POJOBulletRecordConverter

public abstract class BulletRecordConverter
extends Object
implements Serializable

BulletRecordConverter is used to convert objects into BulletRecords. Converters should extend this class and expect configuration though BulletDSLConfig. If a BulletRecordSchema is provided, and type-checking is enabled, the converter will check that values match their types in the schema and throw if they do not. If a schema is not provided, the level of type-checking is left to the implementation.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected BulletDSLConfig	config
protected BulletRecordSchema	schema
protected boolean	shouldTypeCheck

Constructor Summary

Constructors

Constructor and Description
BulletRecordConverter(com.yahoo.bullet.common.BulletConfig bulletConfig) Constructor that takes a configuration containing the settings relevant for this converter.

Method Summary

Modifier and Type	Method and Description
protected BulletRecordConverter	build() Helper function used to initialize BulletRecordConverter from BulletDSLConfig.
com.yahoo.bullet.record.BulletRecord	convert(Object object) Converts an object to a BulletRecord using the configuration-defined implementation of BulletRecord.
com.yahoo.bullet.record.BulletRecord	convert(Object object, com.yahoo.bullet.record.BulletRecord record) Converts an object to a BulletRecord using the given record.
protected void	flattenMap(Map<String,Serializable> mapRecord, com.yahoo.bullet.record.BulletRecord record) Takes the fields of a map and inserts them into a BulletRecord.
static BulletRecordConverter	from(BulletDSLConfig config) Creates a BulletRecordConverter instance using the specified class.
protected abstract Object	get(Object object, String base) Gets the specified top-level field from the object.
protected Object	getField(Object object, String field) Gets the specified inner field from the object.
protected com.yahoo.bullet.typesystem.TypedObject	getTypedObject(String name, com.yahoo.bullet.typesystem.Type type, Serializable value) Converts the field value with the given name and expected type into a TypedObject.
protected void	setField(BulletRecordField field, Object value, com.yahoo.bullet.record.BulletRecord record) Sets the field in a BulletRecord.

Methods inherited from class java.lang.Object

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

Field Detail

config

protected BulletDSLConfig config

schema

protected BulletRecordSchema schema

shouldTypeCheck

protected boolean shouldTypeCheck

Constructor Detail

BulletRecordConverter

public BulletRecordConverter(com.yahoo.bullet.common.BulletConfig bulletConfig)

Constructor that takes a configuration containing the settings relevant for this converter.

Parameters:

bulletConfig - The BulletConfig to use.

Method Detail

build

protected BulletRecordConverter build()
                               throws BulletDSLException

Helper function used to initialize BulletRecordConverter from BulletDSLConfig. The default implementation sets the BulletRecordProvider, and optionally the BulletRecordSchema, used by the converter.

Returns:

This initialized BulletRecordConverter.

Throws:

BulletDSLException - if there is an error creating the converter.

convert

public com.yahoo.bullet.record.BulletRecord convert(Object object)
                                             throws BulletDSLException

Converts an object to a BulletRecord using the configuration-defined implementation of BulletRecord.

Parameters:

object - The object to be converted.

Returns:

A BulletRecord with fields from object.

Throws:

BulletDSLException - if there is an error converting the object to a BulletRecord.

convert

public com.yahoo.bullet.record.BulletRecord convert(Object object,
                                                    com.yahoo.bullet.record.BulletRecord record)
                                             throws BulletDSLException

Converts an object to a BulletRecord using the given record. The default implementation assumes a valid schema.

Parameters:

object - The object to be converted.

record - The record to insert fields into.

Returns:

The record with additional fields from object.

Throws:

BulletDSLException - if there is an error converting the object to a BulletRecord.

setField

protected void setField(BulletRecordField field,
                        Object value,
                        com.yahoo.bullet.record.BulletRecord record)

Sets the field in a BulletRecord.

Parameters:

field - The field to set.

value - The value to set the field to.

record - The record to set the field in.

flattenMap

protected void flattenMap(Map<String,Serializable> mapRecord,
                          com.yahoo.bullet.record.BulletRecord record)

Takes the fields of a map and inserts them into a BulletRecord.

Parameters:

mapRecord - The map to take fields from.

record - The BulletRecord to insert fields into.

get

protected abstract Object get(Object object,
                              String base)

Gets the specified top-level field from the object.

Parameters:

object - The object to get from.

base - The top-level field to get.

Returns:

The value of the specified top-level field from the object or null if it does not exist.

getField

protected Object getField(Object object,
                          String field)

Gets the specified inner field from the object.

Parameters:

object - The object to get from.

field - The inner field to get.

Returns:

The value of the specified inner field from the object or null if it does not exist.

getTypedObject

protected com.yahoo.bullet.typesystem.TypedObject getTypedObject(String name,
                                                                 com.yahoo.bullet.typesystem.Type type,
                                                                 Serializable value)

Converts the field value with the given name and expected type into a TypedObject. If type checking is enabled, it will check to make sure that the expected type matches the final type in the TypedObject. This method is only used for non-record fields.

Parameters:

name - The name of the field.

type - The expected type of the field.

value - The Serializable value of the field.

Returns:

A TypedObject wrapping the value.

from

public static BulletRecordConverter from(BulletDSLConfig config)

Creates a BulletRecordConverter instance using the specified class.

Parameters:

config - The configuration containing the BulletRecordConverter class name and other relevant settings.

Returns:

A new instance of the specified BulletRecordConverter class.