org.apache.pig.impl.streaming

Class PigStreamingUDF

java.lang.Object

org.apache.pig.PigStreamingBase

org.apache.pig.impl.streaming.PigStreamingUDF

All Implemented Interfaces:

PigToStream, StreamToPig

public class PigStreamingUDF
extends PigStreamingBase

Constructor Summary

Constructors

Constructor and Description
PigStreamingUDF()
PigStreamingUDF(Schema.FieldSchema topLevelFs)

Method Summary

Methods

Modifier and Type	Method and Description
Tuple	deserialize(byte[] bytes, int offset, int length) Given a byte array from a streaming executable, produce a tuple.
LoadCaster	getLoadCaster() This will be called on the front end during planning and not on the back end during execution.
byte[]	getRecordDelim()
WritableByteArray	serializeToBytes(Tuple t) Given a tuple, produce an array of bytes to be passed to the streaming executable.

Methods inherited from class org.apache.pig.PigStreamingBase

deserialize, serialize

Methods inherited from class java.lang.Object

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

Constructor Detail

PigStreamingUDF

public PigStreamingUDF()

PigStreamingUDF

public PigStreamingUDF(Schema.FieldSchema topLevelFs)

Method Detail

serializeToBytes

public WritableByteArray serializeToBytes(Tuple t)
                                   throws java.io.IOException

Description copied from class: PigStreamingBase

Given a tuple, produce an array of bytes to be passed to the streaming executable.

Specified by:

serializeToBytes in class PigStreamingBase

Parameters:

t - Tuple to serialize

Returns:

Serialized form of the tuple

Throws:

java.io.IOException

getLoadCaster

public LoadCaster getLoadCaster()
                         throws java.io.IOException

Description copied from class: PigStreamingBase

This will be called on the front end during planning and not on the back end during execution.

Specified by:

getLoadCaster in interface StreamToPig

Specified by:

getLoadCaster in class PigStreamingBase

Returns:

the LoadCaster associated with this object, or null if there is no such LoadCaster.

Throws:

java.io.IOException - if there is an exception during LoadCaster

deserialize

public Tuple deserialize(byte[] bytes,
                int offset,
                int length)
                  throws java.io.IOException

Description copied from class: PigStreamingBase

Given a byte array from a streaming executable, produce a tuple.

Specified by:

deserialize in class PigStreamingBase

Parameters:

bytes - bytes to deserialize.

offset - the offset in the byte array from which to deserialize.

length - the number of bytes from the offset of the byte array to deserialize.

Returns:

Data as a Pig Tuple.

Throws:

java.io.IOException

getRecordDelim

public byte[] getRecordDelim()