org.apache.avro.protobuf

Class ProtobufData

java.lang.Object

org.apache.avro.generic.GenericData

org.apache.avro.protobuf.ProtobufData

public class ProtobufData
extends GenericData

Utilities for serializing Protobuf data in Avro format.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.avro.generic.GenericData

GenericData.Array<T>, GenericData.EnumSymbol, GenericData.Fixed, GenericData.Record, GenericData.StringType

Field Summary

Fields inherited from class org.apache.avro.generic.GenericData

STRING_PROP, STRING_TYPE_STRING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProtobufData()

Method Summary

Methods

Modifier and Type	Method and Description
DatumReader	createDatumReader(Schema schema) Returns a DatumReader for this kind of data.
static ProtobufData	get() Return the singleton instance.
Object	getField(Object r, String name, int pos) Called by GenericDatumReader.readRecord(java.lang.Object, org.apache.avro.Schema, org.apache.avro.io.ResolvingDecoder) to retrieve a record field value from a reused instance.
protected Object	getField(Object record, String name, int pos, Object state) Version of GenericData.getField(java.lang.Object, java.lang.String, int) that has state.
protected Schema	getRecordSchema(Object record) Called to obtain the schema of a record.
protected Object	getRecordState(Object r, Schema s) Produce state for repeated calls to GenericData.getField(Object,String,int,Object) and GenericData.setField(Object,String,int,Object,Object) on the same record.
Schema	getSchema(Class c) Return a record schema given a protobuf message class.
protected boolean	isArray(Object datum) Called by the default implementation of GenericData.instanceOf(org.apache.avro.Schema, java.lang.Object).
protected boolean	isBytes(Object datum) Called by the default implementation of GenericData.instanceOf(org.apache.avro.Schema, java.lang.Object).
protected boolean	isRecord(Object datum) Called by the default implementation of GenericData.instanceOf(org.apache.avro.Schema, java.lang.Object).
Object	newRecord(Object old, Schema schema) Called to create new record instances.
void	setField(Object r, String n, int pos, Object o) Called by GenericDatumReader.readRecord(java.lang.Object, org.apache.avro.Schema, org.apache.avro.io.ResolvingDecoder) to set a record fields value to a record instance.
protected void	setField(Object r, String n, int pos, Object o, Object state) Version of GenericData.setField(java.lang.Object, java.lang.String, int, java.lang.Object) that has state.

Methods inherited from class org.apache.avro.generic.GenericData

compare, compare, createFixed, createFixed, deepCopy, getEnumSchema, getFixedSchema, getSchemaName, hashCode, hashCodeAdd, induce, instanceOf, isEnum, isFixed, isMap, isString, resolveUnion, setStringType, toString, toString, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtobufData

protected ProtobufData()

Method Detail

get

public static ProtobufData get()

Return the singleton instance.

createDatumReader

public DatumReader createDatumReader(Schema schema)

Description copied from class: GenericData

Returns a DatumReader for this kind of data.

Overrides:

createDatumReader in class GenericData

setField

public void setField(Object r,
            String n,
            int pos,
            Object o)

Description copied from class: GenericData

Called by GenericDatumReader.readRecord(java.lang.Object, org.apache.avro.Schema, org.apache.avro.io.ResolvingDecoder) to set a record fields value to a record instance. The default implementation is for IndexedRecord.

Overrides:

setField in class GenericData

getField

public Object getField(Object r,
              String name,
              int pos)

Description copied from class: GenericData

Called by GenericDatumReader.readRecord(java.lang.Object, org.apache.avro.Schema, org.apache.avro.io.ResolvingDecoder) to retrieve a record field value from a reused instance. The default implementation is for IndexedRecord.

Overrides:

getField in class GenericData

setField

protected void setField(Object r,
            String n,
            int pos,
            Object o,
            Object state)

Description copied from class: GenericData

Version of GenericData.setField(java.lang.Object, java.lang.String, int, java.lang.Object) that has state.

Overrides:

setField in class GenericData

getField

protected Object getField(Object record,
              String name,
              int pos,
              Object state)

Description copied from class: GenericData

Version of GenericData.getField(java.lang.Object, java.lang.String, int) that has state.

Overrides:

getField in class GenericData

getRecordState

protected Object getRecordState(Object r,
                    Schema s)

Description copied from class: GenericData

Produce state for repeated calls to GenericData.getField(Object,String,int,Object) and GenericData.setField(Object,String,int,Object,Object) on the same record.

Overrides:

getRecordState in class GenericData

isRecord

protected boolean isRecord(Object datum)

Description copied from class: GenericData

Called by the default implementation of GenericData.instanceOf(org.apache.avro.Schema, java.lang.Object).

Overrides:

isRecord in class GenericData

newRecord

public Object newRecord(Object old,
               Schema schema)

Description copied from class: GenericData

Called to create new record instances. Subclasses may override to use a different record implementation. The returned instance must conform to the schema provided. If the old object contains fields not present in the schema, they should either be removed from the old object, or it should create a new instance that conforms to the schema. By default, this returns a GenericData.Record.

Overrides:

newRecord in class GenericData

isArray

protected boolean isArray(Object datum)

Description copied from class: GenericData

Called by the default implementation of GenericData.instanceOf(org.apache.avro.Schema, java.lang.Object).

Overrides:

isArray in class GenericData

isBytes

protected boolean isBytes(Object datum)

Description copied from class: GenericData

Called by the default implementation of GenericData.instanceOf(org.apache.avro.Schema, java.lang.Object).

Overrides:

isBytes in class GenericData

getRecordSchema

protected Schema getRecordSchema(Object record)

Description copied from class: GenericData

Called to obtain the schema of a record. By default calls {GenericContainer#getSchema(). May be overridden for alternate record representations.

Overrides:

getRecordSchema in class GenericData

getSchema

public Schema getSchema(Class c)

Return a record schema given a protobuf message class.