com.googlecode.paradox.function.numeric.PowerFunction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of paradoxdriver Show documentation
A Paradox Java Driver (using JDBC 4)
The newest version!
/*
 * Copyright (c) 2009 Leonardo Alves da Costa
 *
 * This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
 * later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
 * License for more details. You should have received a copy of the GNU General Public License along with this
 * program. If not, see .
 */
package com.googlecode.paradox.function.numeric;

import com.googlecode.paradox.ConnectionInfo;
import com.googlecode.paradox.planner.nodes.FieldNode;
import com.googlecode.paradox.results.Column;
import com.googlecode.paradox.results.ParadoxType;
import com.googlecode.paradox.rowset.ValuesConverter;

/**
 * The SQL POWER functions.
 *
 * @since 1.6.0
 */
public class PowerFunction extends AbstractNumericFunction {

    /**
     * The function name.
     */
    public static final String NAME = "POWER";

    /**
     * Column parameter list.
     */
    private static final Column[] COLUMNS = {
            new Column(null, ParadoxType.NUMBER, "A radian number.", 0, false, RESULT),
            new Column("number", ParadoxType.NUMBER, "The base number.", 1, false, IN),
            new Column("exponent", ParadoxType.NUMBER, "The exponent number.", 2, false, IN)
    };

    /**
     * Creates a new instance.
     */
    public PowerFunction() {
        super();
    }

    @Override
    public String getRemarks() {
        return "Returns the value of a number raised to the power of another number.";
    }

    @Override
    public Column[] getColumns() {
        return COLUMNS;
    }

    @Override
    public Object execute(final ConnectionInfo connectionInfo, final Object[] values, final ParadoxType[] types, final FieldNode[] fields) {
        final Double value = ValuesConverter.getDouble(values[0], connectionInfo);
        final Double exponent = ValuesConverter.getDouble(values[1], connectionInfo);
        if (value == null || exponent == null) {
            return null;
        }

        return Math.pow(value, exponent);
    }
}