org.expasy.mzjava.avro.io

Class AvroIO<U extends AvroExternalizable>

java.lang.Object

org.expasy.mzjava.avro.io.AvroIO<U>

Direct Known Subclasses:

AbstractAvroReader, AbstractAvroWriter

public abstract class AvroIO<U extends AvroExternalizable>
extends Object

Base class for MzJava Hadoop Avro IO. Helps with creating Avro schemas. Works with both AvroWriter and and AvroReader implementations

Version:

sqrt -1

Author:

Oliver Horlacher

Constructor Summary

Constructors

Constructor and Description
AvroIO()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.avro.Schema	createEnumSchema(Class<? extends Enum> clazz, Enum... enums)
protected abstract void	createRecordFields(List<org.apache.avro.Schema.Field> fields) Create a list containing the Schema.Fields for the fields that this class writes
org.apache.avro.Schema	createSchema() Creates a schema for this reader or writer
org.apache.avro.Schema.Field	createSchemaField(String name, org.apache.avro.Schema schema) Utility method for creating a Field
org.apache.avro.Schema	createUnionSchema(Class recordSuperClass) Utility method for creating a schema for the union for the recordSuperclass for unions that were registered with registerUnion
protected org.apache.avro.Schema	createUnionSchema(Class recordSuperClass, AvroExternalizable... members) Utility method for creating a schema for the union for the recordSuperclass for unions that were registered with registerUnion
protected String	getRecordDoc() Returns the documentation for this record Default is to have no documentation, subclasses can override this to provide doc
protected abstract String	getRecordName() Return the name of this record
protected abstract String	getRecordNameSpace() Return the namespace of this record
protected List<U>	getUnion(Class recordSuperclass) Return the readers or writers for the union of the recordSuperclass
void	registerUnion(Class recordSuperclass, U... externalizables) Register a union
protected String	rewriteNameSpace(Class clazz) Rewrite the class namespace to the serialization namespace

Methods inherited from class java.lang.Object

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

Constructor Detail

AvroIO

public AvroIO()

Method Detail

createSchema

public org.apache.avro.Schema createSchema()

Creates a schema for this reader or writer

Returns:

the schema

createRecordFields

protected abstract void createRecordFields(List<org.apache.avro.Schema.Field> fields)

Create a list containing the Schema.Fields for the fields that this class writes

Parameters:

fields - the list to add the fields to

getRecordDoc

protected String getRecordDoc()

Returns the documentation for this record Default is to have no documentation, subclasses can override this to provide doc

Returns:

the documentation for this record

getRecordName

protected abstract String getRecordName()

Return the name of this record

Returns:

the name of this record

getRecordNameSpace

protected abstract String getRecordNameSpace()

Return the namespace of this record

Returns:

the namespace of this record

rewriteNameSpace

protected String rewriteNameSpace(Class clazz)

Rewrite the class namespace to the serialization namespace

Parameters:

clazz - the class

Returns:

the rewritten namespace

createUnionSchema

public org.apache.avro.Schema createUnionSchema(Class recordSuperClass)

Utility method for creating a schema for the union for the recordSuperclass for unions that were registered with registerUnion

Parameters:

recordSuperClass - the base class

Returns:

the schema for the union for the recordSuperclass

createUnionSchema

protected org.apache.avro.Schema createUnionSchema(Class recordSuperClass,
                                       AvroExternalizable... members)

Utility method for creating a schema for the union for the recordSuperclass for unions that were registered with registerUnion

Parameters:

recordSuperClass - the base class

Returns:

the schema for the union for the recordSuperclass

createSchemaField

public org.apache.avro.Schema.Field createSchemaField(String name,
                                             org.apache.avro.Schema schema)

Utility method for creating a Field

Parameters:

name - the field name

schema - the schema for the field

Returns:

new Schema.Field

createEnumSchema

protected org.apache.avro.Schema createEnumSchema(Class<? extends Enum> clazz,
                                      Enum... enums)

registerUnion

public void registerUnion(Class recordSuperclass,
                 U... externalizables)

Register a union

Parameters:

recordSuperclass - the superclass of the classes in the union

externalizables - the readers or externalizables for the classes in the union

getUnion

protected List<U> getUnion(Class recordSuperclass)

Return the readers or writers for the union of the recordSuperclass

Parameters:

recordSuperclass - the superclass

Returns:

the readers or writers for the union of the recordSuperclass