com.aliyun.odps.udf

Class Outputer

java.lang.Object

com.aliyun.odps.udf.Outputer

public abstract class Outputer
extends Object

Base outputer class, custom outputer shall extend from this class

Constructor Summary

Constructors

Constructor and Description
Outputer()

Method Summary

Modifier and Type	Method and Description
abstract void	close() Interface for cleaning up outputer before exit.
abstract void	output(Record record) Interface for writing a record via output stream.
abstract void	setup(ExecutionContext ctx, OutputStreamSet outputStreamSet, DataAttributes attributes) Interface for setting up the outputer

Methods inherited from class java.lang.Object

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

Constructor Detail

Outputer

public Outputer()

Method Detail

setup

public abstract void setup(ExecutionContext ctx,
                           OutputStreamSet outputStreamSet,
                           DataAttributes attributes)
                    throws IOException

Interface for setting up the outputer

Parameters:

ctx: - the ExecutionContext which contains context information that may be useful for setting up user code execution environment.

outputStreamSet: - set of output streams this outputer write to, when customized external storage is used, this will be empty and user will be responsible for interacting with customized storage.

attributes: - encapsulate any attributes needed that describe the associated output data and/or any other useful information for outputer

Throws:

IOException

output

public abstract void output(Record record)
                     throws IOException

Interface for writing a record via output stream. Each record for output will invoke this function call, The system assumes that each record can be safely disposed after output, and the system might reuse the Record memory. However, user can consolidate multiple records into his/her own managed memory and do a batch deserialization in one shot - if that is more desirable.

Parameters:

record: - a record for output.

Throws:

IOException

close

public abstract void close()
                    throws IOException

Interface for cleaning up outputer before exit. The system will not attempt to close the physical output stream until AFTER the close() call, therefore if there is anything in-memory that the user wish to output, it can still be done by invoking one of the write methods in SinkOutputStream

Throws:

IOException