io.crate.operation.scalar.timestamp.CurrentTimestampFunction.java Source code

Introduction

Here is the source code for io.crate.operation.scalar.timestamp.CurrentTimestampFunction.java

Source

/*
 * Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
 * license agreements.  See the NOTICE file distributed with this work for
 * additional information regarding copyright ownership.  Crate 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.
 *
 * However, if you have executed another commercial license agreement
 * with Crate these terms will supersede the license and you may use the
 * software solely pursuant to the terms of the relevant commercial agreement.
 */

package io.crate.operation.scalar.timestamp;

import com.google.common.collect.ImmutableList;
import com.google.common.math.LongMath;
import io.crate.analyze.symbol.Function;
import io.crate.analyze.symbol.Literal;
import io.crate.analyze.symbol.Symbol;
import io.crate.analyze.symbol.format.FunctionFormatSpec;
import io.crate.metadata.FunctionIdent;
import io.crate.metadata.FunctionInfo;
import io.crate.metadata.Scalar;
import io.crate.metadata.TransactionContext;
import io.crate.operation.Input;
import io.crate.operation.scalar.ScalarFunctionModule;
import io.crate.types.DataType;
import io.crate.types.DataTypes;
import org.joda.time.DateTimeUtils;

import java.math.RoundingMode;
import java.util.Locale;

public class CurrentTimestampFunction extends Scalar<Long, Integer> implements FunctionFormatSpec {

    public static final String NAME = "current_timestamp";
    public static final int DEFAULT_PRECISION = 3;

    public static final FunctionInfo INFO = new FunctionInfo(
            new FunctionIdent(NAME, ImmutableList.<DataType>of(DataTypes.INTEGER)), DataTypes.TIMESTAMP);

    public static void register(ScalarFunctionModule function) {
        function.register(new CurrentTimestampFunction());
    }

    @Override
    public Long evaluate(Input<Integer>... args) {
        long millis = DateTimeUtils.currentTimeMillis();
        Integer precision = 3;
        if (args.length == 1) {
            precision = args[0].value();
            if (precision == null) {
                throw new IllegalArgumentException(
                        String.format(Locale.ENGLISH, "NULL precision not supported for %s", NAME));
            }
        }
        return applyPrecision(millis, precision);
    }

    private static long applyPrecision(long millis, int precision) {
        int factor;
        switch (precision) {
        case 0:
            factor = 1000;
            break;
        case 1:
            factor = 100;
            break;
        case 2:
            factor = 10;
            break;
        case 3:
            return millis;
        default:
            throw new IllegalArgumentException("Precision must be between 0 and 3");
        }
        return LongMath.divide(millis, factor, RoundingMode.DOWN) * factor;
    }

    @Override
    public FunctionInfo info() {
        return INFO;
    }

    @Override
    public Symbol normalizeSymbol(Function function, TransactionContext transactionContext) {
        if (transactionContext == null) {
            return eval(function, DateTimeUtils.currentTimeMillis());
        }
        // use evaluatedFunctions map to make sure multiple occurrences of current_timestamp within a query result in the same result
        return eval(function, transactionContext.currentTimeMillis());
    }

    private Symbol eval(Function function, long currentTimeMillis) {
        Symbol symbol;
        if (function.arguments().isEmpty()) {
            symbol = Literal.of(INFO.returnType(), currentTimeMillis);
        } else {
            Symbol precision = function.arguments().get(0);
            if (precision.symbolType().isValueSymbol()) {
                symbol = Literal.of(INFO.returnType(),
                        applyPrecision(currentTimeMillis, (Integer) ((Input) precision).value()));
            } else {
                throw new IllegalArgumentException(String.format(Locale.ENGLISH, "Invalid argument to %s", NAME));
            }
        }
        return symbol;
    }

    @Override
    public String beforeArgs(Function function) {
        return "current_timestamp" + (function.arguments().isEmpty() ? "" : "(");
    }

    @Override
    public String afterArgs(Function function) {
        return function.arguments().isEmpty() ? "" : ")";
    }

    @Override
    public boolean formatArgs(Function function) {
        return !function.arguments().isEmpty();
    }
}