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

Class GenericUDFTrunc

java.lang.Object

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

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

All Implemented Interfaces:

Closeable, AutoCloseable

public class GenericUDFTrunc
extends GenericUDF

GenericUDFTrunc. Returns the first day of the month which the date belongs to. The time part of the date will be ignored.

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
GenericUDFTrunc()

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.
ObjectInspector	initialize(ObjectInspector[] arguments) Initialize this GenericUDF.
protected BigDecimal	trunc(BigDecimal input, int scale)
protected double	trunc(double input, int scale)
protected DoubleWritable	trunc(DoubleWritable input, int scale)
protected HiveDecimal	trunc(HiveDecimal input, int scale)
protected long	trunc(long input, int scale)

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, getFuncName, 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

GenericUDFTrunc

public GenericUDFTrunc()

Method Detail

initialize

public ObjectInspector initialize(ObjectInspector[] arguments)
                           throws UDFArgumentException

Description copied from class: GenericUDF

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

Description copied from class: GenericUDF

Evaluate the GenericUDF with the arguments.

Specified by:

evaluate in class GenericUDF

Parameters:

arguments - The arguments as DeferedObject, use DeferedObject.get() to get the actual argument Object. The Objects can be inspected by the ObjectInspectors passed in the initialize call.

Returns:

The

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

trunc

protected HiveDecimal trunc(HiveDecimal input,
                            int scale)

trunc

protected long trunc(long input,
                     int scale)

trunc

protected double trunc(double input,
                       int scale)

trunc

protected DoubleWritable trunc(DoubleWritable input,
                               int scale)

trunc

protected BigDecimal trunc(BigDecimal input,
                           int scale)