org.apache.hadoop.hive.ql.udf.generic

Class GenericUDFTumbledWindow

java.lang.Object

org.apache.hadoop.hive.ql.udf.generic.GenericUDF

org.apache.hadoop.hive.ql.udf.generic.GenericUDFTumbledWindow

All Implemented Interfaces:

Closeable, AutoCloseable

public class GenericUDFTumbledWindow
extends GenericUDF

Tumbling windows are a series of fixed-sized, non-overlapping and contiguous time intervals. Tumbling windows are inclusive start exclusive end. By default the beginning instant of fist window is Epoch 0 Thu Jan 01 00:00:00 1970 UTC. Optionally users may provide a different origin as a timestamp arg3. This an example of series of window with an interval of 5 seconds and origin Epoch 0 Thu Jan 01 00:00:00 1970 UTC: interval 1 interval 2 interval 3 Jan 01 00:00:00 Jan 01 00:00:05 Jan 01 00:00:10 0 -------------- 4 : 5 --------------- 9: 10 --------------- 14 This UDF rounds timestamp agr1 to the beginning of window interval where it belongs to.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hive.ql.udf.generic.GenericUDF

GenericUDF.DeferredJavaObject, GenericUDF.DeferredObject

Constructor Summary

Constructors

Constructor and Description
GenericUDFTumbledWindow()

Method Summary

Modifier and Type	Method and Description
Object	evaluate(GenericUDF.DeferredObject[] arguments) Evaluate the GenericUDF with the arguments.
String	getDisplayString(String[] children) Get the String to be displayed in explain.
protected String	getFuncName()
ObjectInspector	initialize(ObjectInspector[] arguments) Initialize this GenericUDF.

Methods inherited from class org.apache.hadoop.hive.ql.udf.generic.GenericUDF

adapt, checkArgGroups, checkArgPrimitive, checkArgsSize, close, configure, copyToNewInstance, flip, getArgOrder, getConstantBooleanValue, getConstantIntValue, getConstantStringValue, getDateValue, getDoubleValue, getIntervalDayTimeValue, getIntervalYearMonthValue, getIntValue, getLongValue, getRequiredFiles, getRequiredJars, getStandardDisplayString, getStandardDisplayString, getStringValue, getTimestampValue, getUdfName, initializeAndFoldConstants, negative, obtainDateConverter, obtainDoubleConverter, obtainIntConverter, obtainLongConverter, obtainStringConverter, obtainTimestampConverter

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericUDFTumbledWindow

public GenericUDFTumbledWindow()

Method Detail

initialize

public ObjectInspector initialize(ObjectInspector[] arguments)
                           throws UDFArgumentException

Initialize this GenericUDF. This will be called once and only once per GenericUDF instance.

Specified by:

initialize in class GenericUDF

Parameters:

arguments - The ObjectInspector for the arguments

Returns:

The ObjectInspector for the return value

Throws:

UDFArgumentException - Thrown when arguments have wrong types, wrong length, etc.

evaluate

public Object evaluate(GenericUDF.DeferredObject[] arguments)
                throws HiveException

Evaluate the GenericUDF with the arguments.

Specified by:

evaluate in class GenericUDF

Parameters:

arguments - timestamp and interval.

Returns:

The truncated timestamp to the beginning of tumbled window interval.

Throws:

HiveException

getDisplayString

public String getDisplayString(String[] children)

Description copied from class: GenericUDF

Get the String to be displayed in explain.

Specified by:

getDisplayString in class GenericUDF

getFuncName

protected String getFuncName()

Overrides:

getFuncName in class GenericUDF