org.apache.avro.generic
Class GenericDatumWriter<D>

java.lang.Object
  extended by org.apache.avro.generic.GenericDatumWriter<D>
All Implemented Interfaces:
DatumWriter<D>
Direct Known Subclasses:
SpecificDatumWriter

public class GenericDatumWriter<D>
extends Object
implements DatumWriter<D>

DatumWriter for generic Java objects.


Constructor Summary
  GenericDatumWriter()
           
protected GenericDatumWriter(GenericData data)
           
  GenericDatumWriter(Schema root)
           
protected GenericDatumWriter(Schema root, GenericData data)
           
 
Method Summary
protected  Iterator<? extends Object> getArrayElements(Object array)
          Called by the default implementation of writeArray(org.apache.avro.Schema, java.lang.Object, org.apache.avro.io.Encoder) to enumerate array elements.
protected  long getArraySize(Object array)
          Called by the default implementation of writeArray(org.apache.avro.Schema, java.lang.Object, org.apache.avro.io.Encoder) to get the size of an array.
 GenericData getData()
          Return the GenericData implementation.
protected  Iterable<Map.Entry<Object,Object>> getMapEntries(Object map)
          Called by the default implementation of writeMap(org.apache.avro.Schema, java.lang.Object, org.apache.avro.io.Encoder) to enumerate map elements.
protected  int getMapSize(Object map)
          Called by the default implementation of writeMap(org.apache.avro.Schema, java.lang.Object, org.apache.avro.io.Encoder) to get the size of a map.
protected  NullPointerException npe(NullPointerException e, String s)
          Helper method for adding a message to an NPE.
 void setSchema(Schema root)
          Set the schema.
 void write(D datum, Encoder out)
          Write a datum.
protected  void write(Schema schema, Object datum, Encoder out)
          Called to write data.
protected  void writeArray(Schema schema, Object datum, Encoder out)
          Called to write a array.
protected  void writeBytes(Object datum, Encoder out)
          Called to write a bytes.
protected  void writeEnum(Schema schema, Object datum, Encoder out)
          Called to write an enum value.
protected  void writeFixed(Schema schema, Object datum, Encoder out)
          Called to write a fixed value.
protected  void writeMap(Schema schema, Object datum, Encoder out)
          Called to write a map.
protected  void writeRecord(Schema schema, Object datum, Encoder out)
          Called to write a record.
protected  void writeString(Object datum, Encoder out)
          Called to write a string.
protected  void writeString(Schema schema, Object datum, Encoder out)
          Called to write a string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GenericDatumWriter

public GenericDatumWriter()

GenericDatumWriter

protected GenericDatumWriter(GenericData data)

GenericDatumWriter

public GenericDatumWriter(Schema root)

GenericDatumWriter

protected GenericDatumWriter(Schema root,
                             GenericData data)
Method Detail

getData

public GenericData getData()
Return the GenericData implementation.


setSchema

public void setSchema(Schema root)
Description copied from interface: DatumWriter
Set the schema.

Specified by:
setSchema in interface DatumWriter<D>

write

public void write(D datum,
                  Encoder out)
           throws IOException
Description copied from interface: DatumWriter
Write a datum. Traverse the schema, depth first, writing each leaf value in the schema from the datum to the output.

Specified by:
write in interface DatumWriter<D>
Throws:
IOException

write

protected void write(Schema schema,
                     Object datum,
                     Encoder out)
              throws IOException
Called to write data.

Throws:
IOException

npe

protected NullPointerException npe(NullPointerException e,
                                   String s)
Helper method for adding a message to an NPE.


writeRecord

protected void writeRecord(Schema schema,
                           Object datum,
                           Encoder out)
                    throws IOException
Called to write a record. May be overridden for alternate record representations.

Throws:
IOException

writeEnum

protected void writeEnum(Schema schema,
                         Object datum,
                         Encoder out)
                  throws IOException
Called to write an enum value. May be overridden for alternate enum representations.

Throws:
IOException

writeArray

protected void writeArray(Schema schema,
                          Object datum,
                          Encoder out)
                   throws IOException
Called to write a array. May be overridden for alternate array representations.

Throws:
IOException

getArraySize

protected long getArraySize(Object array)
Called by the default implementation of writeArray(org.apache.avro.Schema, java.lang.Object, org.apache.avro.io.Encoder) to get the size of an array. The default implementation is for Collection.


getArrayElements

protected Iterator<? extends Object> getArrayElements(Object array)
Called by the default implementation of writeArray(org.apache.avro.Schema, java.lang.Object, org.apache.avro.io.Encoder) to enumerate array elements. The default implementation is for Collection.


writeMap

protected void writeMap(Schema schema,
                        Object datum,
                        Encoder out)
                 throws IOException
Called to write a map. May be overridden for alternate map representations.

Throws:
IOException

getMapSize

protected int getMapSize(Object map)
Called by the default implementation of writeMap(org.apache.avro.Schema, java.lang.Object, org.apache.avro.io.Encoder) to get the size of a map. The default implementation is for Map.


getMapEntries

protected Iterable<Map.Entry<Object,Object>> getMapEntries(Object map)
Called by the default implementation of writeMap(org.apache.avro.Schema, java.lang.Object, org.apache.avro.io.Encoder) to enumerate map elements. The default implementation is for Map.


writeString

protected void writeString(Schema schema,
                           Object datum,
                           Encoder out)
                    throws IOException
Called to write a string. May be overridden for alternate string representations.

Throws:
IOException

writeString

protected void writeString(Object datum,
                           Encoder out)
                    throws IOException
Called to write a string. May be overridden for alternate string representations.

Throws:
IOException

writeBytes

protected void writeBytes(Object datum,
                          Encoder out)
                   throws IOException
Called to write a bytes. May be overridden for alternate bytes representations.

Throws:
IOException

writeFixed

protected void writeFixed(Schema schema,
                          Object datum,
                          Encoder out)
                   throws IOException
Called to write a fixed value. May be overridden for alternate fixed representations.

Throws:
IOException


Copyright © 2011 The Apache Software Foundation. All Rights Reserved.