com.yahoo.bullet.dsl.converter

Class AvroBulletRecordConverter

java.lang.Object

com.yahoo.bullet.dsl.converter.BulletRecordConverter

com.yahoo.bullet.dsl.converter.AvroBulletRecordConverter

All Implemented Interfaces:

Serializable

public class AvroBulletRecordConverter
extends BulletRecordConverter

AvroBulletRecordConverter converts an Avro record into a BulletRecord. The Avro record must use String as its string type.

If a schema is not specified, avro records are effectively flattened without any regard to type-safety.

Note, this class is not related to TypedAvroBulletRecord or UntypedAvroBulletRecord.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	runStringFixer

Fields inherited from class com.yahoo.bullet.dsl.converter.BulletRecordConverter

config, schema, shouldTypeCheck

Constructor Summary

Constructors

Constructor and Description
AvroBulletRecordConverter() Constructs an AvroBulletRecordConverter without a schema.
AvroBulletRecordConverter(com.yahoo.bullet.common.BulletConfig bulletConfig) Constructs an AvroBulletRecordConverter from a given configuration.
AvroBulletRecordConverter(String schema) Constructs an AvroBulletRecordConverter from a given schema.

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, com.yahoo.bullet.record.BulletRecord record) Converts an object to a BulletRecord using the given record.
protected com.yahoo.bullet.record.BulletRecord	convertGenericRecord(org.apache.avro.generic.GenericRecord genericRecord, org.apache.avro.Schema schema, com.yahoo.bullet.record.BulletRecord record) Converts a GenericRecord with a Schema into the provided BulletRecord.
protected 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 void	setField(BulletRecordField field, Object value, com.yahoo.bullet.record.BulletRecord record) Sets the field in a BulletRecord.

Methods inherited from class com.yahoo.bullet.dsl.converter.BulletRecordConverter

convert, flattenMap, from, getTypedObject

Methods inherited from class java.lang.Object

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

Field Detail

runStringFixer

protected boolean runStringFixer

Constructor Detail

AvroBulletRecordConverter

public AvroBulletRecordConverter()
                          throws BulletDSLException

Constructs an AvroBulletRecordConverter without a schema.

Throws:

BulletDSLException - if there is an error creating the converter.

AvroBulletRecordConverter

public AvroBulletRecordConverter(String schema)
                          throws BulletDSLException

Constructs an AvroBulletRecordConverter from a given schema.

Parameters:

schema - A schema file that specifies the fields to extract and their types.

Throws:

BulletDSLException - if there is an error creating the converter.

AvroBulletRecordConverter

public AvroBulletRecordConverter(com.yahoo.bullet.common.BulletConfig bulletConfig)
                          throws BulletDSLException

Constructs an AvroBulletRecordConverter from a given configuration.

Parameters:

bulletConfig - The configuration that specifies the settings for an AvroBulletRecordConverter.

Throws:

BulletDSLException - if there is an error creating the converter.

Method Detail

build

protected BulletRecordConverter build()
                               throws BulletDSLException

Description copied from class: BulletRecordConverter

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

Overrides:

build in class BulletRecordConverter

Returns:

This initialized BulletRecordConverter.

Throws:

BulletDSLException - if there is an error creating the converter.

convert

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

Description copied from class: BulletRecordConverter

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

Overrides:

convert in class BulletRecordConverter

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.

convertGenericRecord

protected com.yahoo.bullet.record.BulletRecord convertGenericRecord(org.apache.avro.generic.GenericRecord genericRecord,
                                                                    org.apache.avro.Schema schema,
                                                                    com.yahoo.bullet.record.BulletRecord record)

Converts a GenericRecord with a Schema into the provided BulletRecord.

Parameters:

genericRecord - The GenericRecord to convert.

schema - The Schema of the GenericRecord.

record - The BulletRecord to place the fields into.

Returns:

The BulletRecord with the added fields.

setField

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

Description copied from class: BulletRecordConverter

Sets the field in a BulletRecord.

Overrides:

setField in class BulletRecordConverter

Parameters:

field - The field to set.

value - The value to set the field to.

record - The record to set the field in.

get

protected Object get(Object object,
                     String base)

Description copied from class: BulletRecordConverter

Gets the specified top-level field from the object.

Specified by:

get in class BulletRecordConverter

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)

Description copied from class: BulletRecordConverter

Gets the specified inner field from the object.

Overrides:

getField in class BulletRecordConverter

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.