/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.hadoop.hive.ql.udf.generic;
import java.text.DecimalFormat;
import org.apache.hadoop.hive.common.type.HiveDecimal;
import org.apache.hadoop.hive.ql.exec.Description;
import org.apache.hadoop.hive.ql.exec.UDFArgumentException;
import org.apache.hadoop.hive.ql.exec.UDFArgumentLengthException;
import org.apache.hadoop.hive.ql.exec.UDFArgumentTypeException;
import org.apache.hadoop.hive.ql.metadata.HiveException;
import org.apache.hadoop.hive.serde.serdeConstants;
import org.apache.hadoop.hive.serde2.objectinspector.ConstantObjectInspector;
import org.apache.hadoop.hive.serde2.objectinspector.ObjectInspector;
import org.apache.hadoop.hive.serde2.objectinspector.PrimitiveObjectInspector;
import org.apache.hadoop.hive.serde2.objectinspector.PrimitiveObjectInspector.PrimitiveCategory;
import org.apache.hadoop.hive.serde2.objectinspector.primitive.DoubleObjectInspector;
import org.apache.hadoop.hive.serde2.objectinspector.primitive.FloatObjectInspector;
import org.apache.hadoop.hive.serde2.objectinspector.primitive.IntObjectInspector;
import org.apache.hadoop.hive.serde2.objectinspector.primitive.LongObjectInspector;
import org.apache.hadoop.hive.serde2.objectinspector.primitive.HiveDecimalObjectInspector;
import org.apache.hadoop.hive.serde2.objectinspector.primitive.PrimitiveObjectInspectorFactory;
import org.apache.hadoop.io.Text;
/**
* Generic UDF for format_number function
* <code>FORMAT_NUMBER(X, D or F)</code>.
* This is supposed to function like MySQL's FORMAT,
* http://dev.mysql.com/doc/refman/5.1/en/string-functions.html#
* function_format
*
* @see org.apache.hadoop.hive.ql.udf.generic.GenericUDF
*/
@Description(name = "format_number",
value = "_FUNC_(X, D or F) - Formats the number X to "
+ "a format like '#,###,###.##', rounded to D decimal places, Or"
+ " Uses the format specified F to format,"
+ " and returns the result as a string. If D is 0, the result"
+ " has no decimal point or fractional part."
+ " This is supposed to function like MySQL's FORMAT",
extended = "Example:\n"
+ " > SELECT _FUNC_(12332.123456, 4) FROM src LIMIT 1;\n"
+ " '12,332.1235'\n"
+ " > SELECT _FUNC_(12332.123456, '##################.###') FROM"
+ " src LIMIT 1;\n"
+ " '12332.123'")
public class GenericUDFFormatNumber extends GenericUDF {
private transient ObjectInspector[] argumentOIs;
private transient final Text resultText = new Text();
private transient final StringBuilder pattern = new StringBuilder("");
private transient final DecimalFormat numberFormat = new DecimalFormat("");
private transient int lastDValue = -1;
private transient PrimitiveCategory dType;
@Override
public ObjectInspector initialize(ObjectInspector[] arguments)
throws UDFArgumentException {
if (arguments.length != 2) {
throw new UDFArgumentLengthException(
"The function FORMAT_NUMBER(X, D or F) needs two arguments.");
}
switch (arguments[0].getCategory()) {
case PRIMITIVE:
break;
default:
throw new UDFArgumentTypeException(0, "Argument 1"
+ " of function FORMAT_NUMBER must be \""
+ serdeConstants.TINYINT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.SMALLINT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.INT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.BIGINT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.DOUBLE_TYPE_NAME + "\""
+ " or \"" + serdeConstants.FLOAT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.DECIMAL_TYPE_NAME + "\", but \""
+ arguments[0].getTypeName() + "\" was found.");
}
switch (arguments[1].getCategory()) {
case PRIMITIVE:
break;
default:
throw new UDFArgumentTypeException(1, "Argument 2"
+ " of function FORMAT_NUMBER must be \""
+ serdeConstants.TINYINT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.SMALLINT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.INT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.BIGINT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.STRING_TYPE_NAME + "\", but \""
+ arguments[1].getTypeName() + "\" was found.");
}
PrimitiveObjectInspector xObjectInspector = (PrimitiveObjectInspector)arguments[0];
PrimitiveObjectInspector dObjectInspector = (PrimitiveObjectInspector)arguments[1];
switch (xObjectInspector.getPrimitiveCategory()) {
case VOID:
case BYTE:
case SHORT:
case INT:
case LONG:
case DOUBLE:
case FLOAT:
case DECIMAL:
break;
default:
throw new UDFArgumentTypeException(0, "Argument 1"
+ " of function FORMAT_NUMBER must be \""
+ serdeConstants.TINYINT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.SMALLINT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.INT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.BIGINT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.DOUBLE_TYPE_NAME + "\""
+ " or \"" + serdeConstants.FLOAT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.DECIMAL_TYPE_NAME + "\", but \""
+ arguments[0].getTypeName() + "\" was found.");
}
dType = dObjectInspector.getPrimitiveCategory();
switch (dType) {
case VOID:
case BYTE:
case SHORT:
case INT:
case LONG:
break;
case STRING:
if (!(arguments[1] instanceof ConstantObjectInspector)) {
throw new UDFArgumentTypeException(1, "Format string passed must be a constant STRING." + arguments[1]
.toString());
}
ConstantObjectInspector constantOI = (ConstantObjectInspector)arguments[1];
String fValue = constantOI.getWritableConstantValue().toString();
DecimalFormat dFormat = new DecimalFormat(fValue);
numberFormat.applyPattern(dFormat.toPattern());
break;
default:
throw new UDFArgumentTypeException(1, "Argument 2"
+ " of function FORMAT_NUMBER must be \""
+ serdeConstants.TINYINT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.SMALLINT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.INT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.BIGINT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.STRING_TYPE_NAME + "\", but \""
+ arguments[1].getTypeName() + "\" was found.");
}
argumentOIs = arguments;
return PrimitiveObjectInspectorFactory.writableStringObjectInspector;
}
@Override
public Object evaluate(DeferredObject[] arguments) throws HiveException {
Object arg0;
Object arg1;
if ((arg0 = arguments[0].get()) == null || (arg1 = arguments[1].get()) == null) {
return null;
}
if (!dType.equals(PrimitiveCategory.STRING)) {
int dValue = ((IntObjectInspector) argumentOIs[1]).get(arg1);
if (dValue < 0) {
throw new HiveException("Argument 2 of function FORMAT_NUMBER must be >= 0, but \""
+ dValue + "\" was found");
}
if (dValue != lastDValue) {
// construct a new DecimalFormat only if a new dValue
pattern.delete(0, pattern.length());
pattern.append("#,###,###,###,###,###,##0");
//decimal place
if (dValue > 0) {
pattern.append(".");
for (int i = 0; i < dValue; i++) {
pattern.append("0");
}
}
DecimalFormat dFormat = new DecimalFormat(pattern.toString());
lastDValue = dValue;
numberFormat.applyPattern(dFormat.toPattern());
}
}
double xDoubleValue = 0.0;
float xFloatValue = 0.0f;
HiveDecimal xDecimalValue = null;
int xIntValue = 0;
long xLongValue = 0L;
PrimitiveObjectInspector xObjectInspector = (PrimitiveObjectInspector)argumentOIs[0];
switch (xObjectInspector.getPrimitiveCategory()) {
case VOID:
case DOUBLE:
xDoubleValue = ((DoubleObjectInspector) argumentOIs[0]).get(arg0);
resultText.set(numberFormat.format(xDoubleValue));
break;
case FLOAT:
xFloatValue = ((FloatObjectInspector) argumentOIs[0]).get(arg0);
resultText.set(numberFormat.format(xFloatValue));
break;
case DECIMAL:
xDecimalValue = ((HiveDecimalObjectInspector) argumentOIs[0])
.getPrimitiveJavaObject(arg0);
resultText.set(numberFormat.format(xDecimalValue.bigDecimalValue()));
break;
case BYTE:
case SHORT:
case INT:
xIntValue = ((IntObjectInspector) argumentOIs[0]).get(arg0);
resultText.set(numberFormat.format(xIntValue));
break;
case LONG:
xLongValue = ((LongObjectInspector) argumentOIs[0]).get(arg0);
resultText.set(numberFormat.format(xLongValue));
break;
default:
throw new HiveException("Argument 1 of function FORMAT_NUMBER must be "
+ serdeConstants.TINYINT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.SMALLINT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.INT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.BIGINT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.DOUBLE_TYPE_NAME + "\""
+ " or \"" + serdeConstants.FLOAT_TYPE_NAME + "\""
+ " or \"" + serdeConstants.DECIMAL_TYPE_NAME + "\", but \""
+ argumentOIs[0].getTypeName() + "\" was found.");
}
return resultText;
}
@Override
public String getDisplayString(String[] children) {
assert (children.length == 2);
return getStandardDisplayString("format_number", children);
}
}