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

Class SimpleGenericUDAFParameterInfo

java.lang.Object

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

All Implemented Interfaces:

GenericUDAFParameterInfo

public class SimpleGenericUDAFParameterInfo
extends Object
implements GenericUDAFParameterInfo

A simple implementation of GenericUDAFParameterInfo.

Constructor Summary

Constructors

Constructor and Description
SimpleGenericUDAFParameterInfo(ObjectInspector[] params, boolean isWindowing, boolean distinct, boolean allColumns)

Method Summary

Modifier and Type	Method and Description
ObjectInspector[]	getParameterObjectInspectors()
TypeInfo[]	getParameters() Deprecated.
boolean	isAllColumns() Returns true if the UDAF invocation was done via the wildcard syntax FUNCTION(*).
boolean	isDistinct() Returns true if the UDAF invocation was qualified with DISTINCT keyword.
boolean	isWindowing() The flag to indicate if the UDAF invocation was from the windowing function call or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleGenericUDAFParameterInfo

public SimpleGenericUDAFParameterInfo(ObjectInspector[] params,
                                      boolean isWindowing,
                                      boolean distinct,
                                      boolean allColumns)

Method Detail

getParameters

@Deprecated
public TypeInfo[] getParameters()

Deprecated.

Specified by:

getParameters in interface GenericUDAFParameterInfo

Returns:

the parameter type list passed into the UDAF.

getParameterObjectInspectors

public ObjectInspector[] getParameterObjectInspectors()

Specified by:

getParameterObjectInspectors in interface GenericUDAFParameterInfo

Returns:

getParameters() with types returned as ObjectInspectors.

isDistinct

public boolean isDistinct()

Description copied from interface: GenericUDAFParameterInfo

Returns true if the UDAF invocation was qualified with DISTINCT keyword. Note that this is provided for informational purposes only and the function implementation is not expected to ensure the distinct property for the parameter values. That is handled by the framework.

Specified by:

isDistinct in interface GenericUDAFParameterInfo

Returns:

true if the UDAF invocation was qualified with DISTINCT keyword, false otherwise.

isAllColumns

public boolean isAllColumns()

Description copied from interface: GenericUDAFParameterInfo

Returns true if the UDAF invocation was done via the wildcard syntax FUNCTION(*). Note that this is provided for informational purposes only and the function implementation is not expected to ensure the wildcard handling of the target relation. That is handled by the framework.

Specified by:

isAllColumns in interface GenericUDAFParameterInfo

Returns:

true if the UDAF invocation was done with a wildcard instead of explicit parameter list.

isWindowing

public boolean isWindowing()

Description copied from interface: GenericUDAFParameterInfo

The flag to indicate if the UDAF invocation was from the windowing function call or not.

Specified by:

isWindowing in interface GenericUDAFParameterInfo

Returns:

true if the UDAF invocation was from the windowing function call.