DatumFactory.java

/**
 * 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.tajo.datum;

import org.apache.commons.codec.binary.Base64;
import org.apache.tajo.common.TajoDataTypes.DataType;
import org.apache.tajo.common.TajoDataTypes.Type;
import org.apache.tajo.exception.InvalidValueForCastException;
import org.apache.tajo.exception.TajoInternalError;
import org.apache.tajo.exception.TajoRuntimeException;
import org.apache.tajo.exception.UnsupportedDataTypeException;
import org.apache.tajo.util.NumberUtil;
import org.apache.tajo.util.datetime.DateTimeFormat;
import org.apache.tajo.util.datetime.DateTimeUtil;
import org.apache.tajo.util.datetime.TimeMeta;

import javax.annotation.Nullable;
import java.io.IOException;
import java.util.TimeZone;

public class DatumFactory {

  public static Class<? extends Datum> getDatumClass(Type type) {
    switch (type) {
      case BOOLEAN:
        return BooleanDatum.class;
      case INT2:
        return Int2Datum.class;
      case INT4:
        return Int4Datum.class;
      case INT8:
        return Int8Datum.class;
      case FLOAT4:
        return Float4Datum.class;
      case FLOAT8:
        return Float8Datum.class;
      case CHAR:
        return CharDatum.class;
      case TEXT:
        return TextDatum.class;
      case TIMESTAMP:
        return TimestampDatum.class;
      case INTERVAL:
        return IntervalDatum.class;
      case DATE:
        return DateDatum.class;
      case TIME:
        return TimeDatum.class;
      case BIT:
        return BitDatum.class;
      case BLOB:
        return BlobDatum.class;
      case ANY:
        return AnyDatum.class;
      case NULL_TYPE:
        return NullDatum.class;
      default:
        throw new TajoRuntimeException(new UnsupportedDataTypeException(type.name()));
    }
  }

  public static Datum createFromString(DataType dataType, String value) {
    switch (dataType.getType()) {

    case BOOLEAN:
      return createBool(value.equals(BooleanDatum.TRUE_STRING));
    case INT2:
      return createInt2(value);
    case INT4:
      return createInt4(value);
    case INT8:
      return createInt8(value);
    case FLOAT4:
      return createFloat4(value);
    case FLOAT8:
      return createFloat8(value);
    case CHAR:
      return createChar(value);
    case TEXT:
      return createText(value);
    case DATE:
      return createDate(value);
    case TIME:
      return createTime(value);
    case TIMESTAMP:
      return createTimestamp(value);
    case INTERVAL:
      return createInterval(value);
    case BLOB:
      return createBlob(value);
    default:
      throw new TajoRuntimeException(new UnsupportedDataTypeException(dataType.toString()));
    }
  }

  public static Datum createFromBytes(DataType dataType, byte[] bytes) {
    switch (dataType.getType()) {

    case BOOLEAN:
      return createBool(bytes[0]);
    case INT2:
      return createInt2(NumberUtil.toShort(bytes));
    case INT4:
      return createInt4(NumberUtil.toInt(bytes));
    case INT8:
      return createInt8(NumberUtil.toLong(bytes));
    case FLOAT4:
      return createFloat4(NumberUtil.toFloat(bytes));
    case FLOAT8:
      return createFloat8(NumberUtil.toDouble(bytes));
    case CHAR:
      return createChar(bytes);
    case TEXT:
      return createText(bytes);
    case DATE:
      return new DateDatum(NumberUtil.toInt(bytes));
    case TIME:
      return new TimeDatum(NumberUtil.toLong(bytes));
    case TIMESTAMP:
      return new TimestampDatum(NumberUtil.toLong(bytes));
    case BIT:
      return createBit(bytes[0]);
    case BLOB:
      return createBlob(bytes);
    case PROTOBUF:
      try {
        return ProtobufDatumFactory.createDatum(dataType, bytes);
      } catch (IOException e) {
        throw new TajoInternalError(e);
      }
    default:
      throw new TajoRuntimeException(new UnsupportedDataTypeException(dataType.toString()));
    }
  }

  public static Datum createFromInt4(DataType type, int val) {
    switch (type.getType()) {
    case INT4:
      return new Int4Datum(val);
    case DATE:
      return new DateDatum(val);
    default:
      throw new TajoRuntimeException(new UnsupportedDataTypeException(type.getType().name()));
    }
  }

  public static Datum createFromInt8(DataType type, long val) {
    switch (type.getType()) {
    case INT8:
      return new Int8Datum(val);
    case TIMESTAMP:
      return new TimestampDatum(val);
    case TIME:
      return createTime(val); 
    default:
      throw new TajoRuntimeException(new UnsupportedDataTypeException(type.getType().name()));
    }
  }

  public static NullDatum createNullDatum() {
    return NullDatum.get();
  }

  public static Datum createBool(byte val) {
    return BooleanDatum.THREE_VALUES[(int)val];
  }

  public static Datum createBool(int val) {
    return BooleanDatum.THREE_VALUES[val];
  }

  public static BooleanDatum createBool(boolean val) {
    return val ? BooleanDatum.TRUE : BooleanDatum.FALSE;
  }

  public static BitDatum createBit(byte val) {
    return new BitDatum(val);
  }

  public static CharDatum createChar(char val) {
    return new CharDatum(val);
  }

  public static CharDatum createChar(byte val) {
    return new CharDatum(val);
  }

  public static CharDatum createChar(byte[] bytes) {
    return new CharDatum(bytes);
  }

  public static CharDatum createChar(String val) {
    return new CharDatum(val);
  }

  public static Int2Datum createInt2(short val) {
    return new Int2Datum(val);
  }

  public static Int2Datum createInt2(String val) {
    return new Int2Datum(Short.valueOf(val));
  }

  public static Int4Datum createInt4(int val) {
    return new Int4Datum(val);
  }

  public static Int4Datum createInt4(String val) {
    return new Int4Datum(Integer.parseInt(val));
  }

  public static Int8Datum createInt8(long val) {
    return new Int8Datum(val);
  }

  public static Int8Datum createInt8(String val) {
    return new Int8Datum(Long.parseLong(val));
  }

  public static Float4Datum createFloat4(float val) {
    return new Float4Datum(val);
  }

  public static Float4Datum createFloat4(String val) {
    return new Float4Datum(Float.valueOf(val));
  }

  public static Float8Datum createFloat8(double val) {
    return new Float8Datum(val);
  }

  public static Float8Datum createFloat8(String val) {
    return new Float8Datum(Double.valueOf(val));
  }

  public static TextDatum createText(String val) {
    return new TextDatum(val);
  }

  public static TextDatum createText(byte[] val) {
    return new TextDatum(val);
  }

  public static DateDatum createDate(int instance) {
    return new DateDatum(instance);
  }

  public static DateDatum createDate(int year, int month, int day) {
    return new DateDatum(DateTimeUtil.date2j(year, month, day));
  }

  public static DateDatum createDate(String dateStr) {
    return new DateDatum(DateTimeUtil.toJulianDate(dateStr));
  }

  public static TimeDatum createTime(long instance) {
    return new TimeDatum(instance);
  }

  public static TimeDatum createTime(String timeStr) {
    return new TimeDatum(DateTimeUtil.toJulianTime(timeStr));
  }

  public static TimestampDatum createTimestampDatumWithJavaMillis(long millis) {
    return new TimestampDatum(DateTimeUtil.javaTimeToJulianTime(millis));
  }

  public static TimestampDatum createTimestampDatumWithUnixTime(int unixTime) {
    return createTimestampDatumWithJavaMillis(unixTime * 1000L);
  }

  public static TimestampDatum createTimestamp(String datetimeStr) {
    return new TimestampDatum(DateTimeUtil.toJulianTimestamp(datetimeStr));
  }

  public static TimestampDatum createTimestamp(String datetimeStr, TimeZone tz) {
    TimeMeta tm = DateTimeUtil.decodeDateTime(datetimeStr);
    DateTimeUtil.toUTCTimezone(tm, tz);
    return new TimestampDatum(DateTimeUtil.toJulianTimestamp(tm));
  }

  public static IntervalDatum createInterval(String intervalStr) {
    return new IntervalDatum(intervalStr);
  }

  @SuppressWarnings("unused")
  public static IntervalDatum createInterval(long interval) {
    return new IntervalDatum(interval);
  }

  public static IntervalDatum createInterval(int month, long interval) {
    return new IntervalDatum(month, interval);
  }

  public static DateDatum createDate(Datum datum) {
    switch (datum.kind()) {
    case INT4:
      return new DateDatum(datum.asInt4());
    case INT8:
      return new DateDatum(datum.asInt4());
    case TEXT:
      return createDate(datum.asChars());
    case DATE:
      return (DateDatum) datum;
    default:
      throw new TajoRuntimeException(new InvalidValueForCastException(datum.type(), Type.DATE));
    }
  }

  public static TimeDatum createTime(Datum datum) {
    switch (datum.kind()) {
    case INT8:
      return new TimeDatum(datum.asInt8());
    case CHAR:
    case VARCHAR:
    case TEXT:
      TimeMeta tm = DateTimeFormat.parseDateTime(datum.asChars(), "HH24:MI:SS.MS");
      return new TimeDatum(DateTimeUtil.toTime(tm));
    case TIME:
      return (TimeDatum) datum;
    default:
      throw new TajoRuntimeException(new InvalidValueForCastException(datum.type(), Type.TIME));
    }
  }

  public static TimestampDatum createTimestamp(Datum datum, @Nullable TimeZone tz) {
    switch (datum.kind()) {
      case CHAR:
      case VARCHAR:
      case TEXT:
        return parseTimestamp(datum.asChars(), tz);
      case TIMESTAMP:
        return (TimestampDatum) datum;
      case DATE: {
        TimeMeta tm = datum.asTimeMeta();
        if (tz != null) {
          DateTimeUtil.toUTCTimezone(tm, tz);
        }
        return new TimestampDatum(DateTimeUtil.toJulianTimestamp(tm));
      }
      default:
        throw new TajoRuntimeException(new InvalidValueForCastException(datum.type(), Type.TIMESTAMP));
    }
  }

  @SuppressWarnings("unused")
  public static TimestampDatum createTimestamp(long julianTimestamp) {
    return new TimestampDatum(julianTimestamp);
  }

  public static TimestampDatum parseTimestamp(String str, @Nullable TimeZone tz) {
    return new TimestampDatum(DateTimeUtil.toJulianTimestampWithTZ(str, tz));
  }

  public static BlobDatum createBlob(byte[] encoded) {
    return new BlobDatum(encoded);
  }

  public static BlobDatum createBlob(byte[] encoded, int offset, int length) {
    return new BlobDatum(encoded, offset, length);
  }

  public static BlobDatum createBlob(String plainString) {
    return new BlobDatum(Base64.encodeBase64(plainString.getBytes()));
  }

  public static AnyDatum createAny(Datum val) {
    return new AnyDatum(val);
  }

  public static Datum cast(Datum operandDatum, org.apache.tajo.type.Type target, @Nullable TimeZone tz) {
    switch (target.kind()) {
    case BOOLEAN:
      return DatumFactory.createBool(operandDatum.asBool());
    case CHAR:
      return DatumFactory.createChar(operandDatum.asChar());
    case INT1:
    case INT2:
      return DatumFactory.createInt2(operandDatum.asInt2());
    case INT4:
      return DatumFactory.createInt4(operandDatum.asInt4());
    case INT8:
      return DatumFactory.createInt8(operandDatum.asInt8());
    case FLOAT4:
      return DatumFactory.createFloat4(operandDatum.asFloat4());
    case FLOAT8:
      return DatumFactory.createFloat8(operandDatum.asFloat8());
    case VARCHAR:
    case TEXT:
      switch (operandDatum.kind()) {
        case TIMESTAMP: {
          TimestampDatum timestampDatum = (TimestampDatum)operandDatum;
          if (tz != null) {
            return DatumFactory.createText(TimestampDatum.asChars(operandDatum.asTimeMeta(), tz, false));
          } else {
            return DatumFactory.createText(timestampDatum.asChars());
          }
        }
        default:
          return DatumFactory.createText(operandDatum.asTextBytes());
      }
    case DATE:
      return DatumFactory.createDate(operandDatum);
    case TIME:
      return DatumFactory.createTime(operandDatum);
    case TIMESTAMP:
      return DatumFactory.createTimestamp(operandDatum, tz);
    case BLOB:
      return DatumFactory.createBlob(operandDatum.asByteArray());
    case ANY:
      return DatumFactory.createAny(operandDatum);
    default:
      throw new TajoRuntimeException(new InvalidValueForCastException(operandDatum.type(), target.kind()));
    }
  }
}