com.aliyun.odps.udf

Class Extractor

java.lang.Object

com.aliyun.odps.udf.Extractor

public abstract class Extractor
extends Object

Base extractor class, user-defined extractors shall extend from this class

Constructor Summary

Constructors

Constructor and Description
Extractor()

Method Summary

Modifier and Type	Method and Description
abstract void	close() Interface for operations upon extractor exit, implementation can be no-op
abstract Record	extract() Interface for extracting a schematized record from an input stream
abstract void	setup(ExecutionContext ctx, InputStreamSet inputs, DataAttributes attributes) Interface for setting up the extractor, implementation can be a no-op

Methods inherited from class java.lang.Object

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

Constructor Detail

Extractor

public Extractor()

Method Detail

setup

public abstract void setup(ExecutionContext ctx,
                           InputStreamSet inputs,
                           DataAttributes attributes)
                    throws IOException

Interface for setting up the extractor, implementation can be a no-op

Parameters:

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

inputs: - set of input streams, each corresponding to one input file

attributes: - encapsulate any attributes needed that describe the associated input data

Throws:

IOException

extract

public abstract Record extract()
                        throws IOException

Interface for extracting a schematized record from an input stream

Returns:

the extracted record, returning null indicates no more record is to be extracted

Throws:

IOException

close

public abstract void close()
                    throws IOException

Interface for operations upon extractor exit, implementation can be no-op

Throws:

IOException