com.yahoo.bullet.dsl.converter

Class POJOBulletRecordConverter

java.lang.Object

com.yahoo.bullet.dsl.converter.BulletRecordConverter

com.yahoo.bullet.dsl.converter.POJOBulletRecordConverter

All Implemented Interfaces:

Serializable

public class POJOBulletRecordConverter
extends BulletRecordConverter

POJOBulletRecordConverter is used to convert POJOs to BulletRecord.

If a schema is not specified, the POJOBulletRecordConverter constructed will convert all valid fields (with valid types) and log a warning for each invalid field. If a schema is specified, method names in addition to member names can be used in references.

Note, POJOBulletRecordConverter uses reflections and is relatively slow; specifying getters in the schema will lead to slightly better performance. Furthermore, the converter only finds declared fields and methods and does not look into superclasses or interfaces.

See Also:

Serialized Form

Field Summary

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

config, schema, shouldTypeCheck

Constructor Summary

Constructors

Constructor and Description
POJOBulletRecordConverter(com.yahoo.bullet.common.BulletConfig bulletConfig) Constructs a POJOBulletRecordConverter from a given configuration.
POJOBulletRecordConverter(Class<?> type) Constructs a POJOBulletRecordConverter without a schema that finds all valid fields regardless of access (protected, private, etc.) though not including inherited fields.
POJOBulletRecordConverter(Class<?> type, String schema) Constructs a POJOBulletRecordConverter 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 Object	get(Object object, String base) Gets the specified top-level field from the object.

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

convert, flattenMap, from, getField, getTypedObject, setField

Methods inherited from class java.lang.Object

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

Constructor Detail

POJOBulletRecordConverter

public POJOBulletRecordConverter(Class<?> type)
                          throws BulletDSLException

Constructs a POJOBulletRecordConverter without a schema that finds all valid fields regardless of access (protected, private, etc.) though not including inherited fields.

Parameters:

type - The POJO class type.

Throws:

BulletDSLException - if there is an error creating the converter.

POJOBulletRecordConverter

public POJOBulletRecordConverter(Class<?> type,
                                 String schema)
                          throws BulletDSLException

Constructs a POJOBulletRecordConverter from a given schema.

Parameters:

type - The POJO class type.

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

Throws:

BulletDSLException - if there is an error creating the converter.

POJOBulletRecordConverter

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

Constructs a POJOBulletRecordConverter from a given configuration.

Parameters:

bulletConfig - The configuration that specifies the settings for a POJOBulletRecordConverter.

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.

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.