/*
 * Copyright (C) 2019, HuntLabs
 *
 * Licensed 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.
 *
 */

module hunt.database.base.Tuple;

import hunt.database.base.impl.ArrayTuple;
// import io.vertx.codegen.annotations.Fluent;
// import io.vertx.codegen.annotations.GenIgnore;
// import io.vertx.codegen.annotations.VertxGen;
// import io.vertx.core.buffer.Buffer;

import hunt.math.BigDecimal;
// import java.time.*;
// import java.time.temporal.Temporal;
// import java.util.UUID;

import std.variant;

import std.typecons;

/**
 * A general purpose tuple.
 */
interface Tuple {

    /**
     * The JSON null literal value.
     * <br/>
     * It is used to distinguish a JSON null literal value from the Java {@code null} value. This is only
     * used when the database supports JSON types.
     */
    // Object JSON_NULL = new Object();

    /**
     * @return a new empty tuple
     */
    static Tuple tuple() {
        return new ArrayTuple(10);
    }

    /**
     * Create a tuple of an arbitrary number of elements.
     *
     * @param elts the elements
     * @return the tuple
     */
    static Tuple of(Args...)(Args elts) {
        ArrayTuple tuple = new ArrayTuple(cast(int)Args.length);
        foreach (elt; elts) {
            static if(is(T == Variant)) {
                tuple.addValue(elt);
            } else {
                Variant v = Variant(elt);
                tuple.addValue(v);
            }
        }
        return tuple;
    }    

    /**
     * Get an object value at {@code pos}.
     *
     * @param pos the position
     * @return the value or {@code null}
     */
    Variant getValue(int pos);

    /// ditto
    alias opIndex = getValue;

    /**
     * Get a boolean value at {@code pos}.
     *
     * @param pos the position
     * @return the value or {@code null}
     */
    bool getBoolean(int pos);

    /**
     * Get a short value at {@code pos}.
     *
     * @param pos the position
     * @return the value or {@code null}
     */
    short getShort(int pos);

    /**
     * Get an integer value at {@code pos}.
     *
     * @param pos the position
     * @return the value or {@code null}
     */
    int getInteger(int pos);

    /**
     * Get a long value at {@code pos}.
     *
     * @param pos the position
     * @return the value or {@code null}
     */
    long getLong(int pos);

    /**
     * Get a float value at {@code pos}.
     *
     * @param pos the position
     * @return the value or {@code null}
     */
    float getFloat(int pos);

    /**
     * Get a double value at {@code pos}.
     *
     * @param pos the position
     * @return the value or {@code null}
     */
    double getDouble(int pos);

    /**
     * Get a string value at {@code pos}.
     *
     * @param pos the position
     * @return the value or {@code null}
     */
    string getString(int pos);

    // /**
    //  * Get a {@link java.time.temporal.Temporal} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // Temporal getTemporal(int pos);

    // /**
    //  * Get {@link java.time.LocalDate} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // LocalDate getLocalDate(int pos);

    // /**
    //  * Get {@link java.time.LocalTime} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // LocalTime getLocalTime(int pos);

    // /**
    //  * Get {@link java.time.LocalDateTime} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // LocalDateTime getLocalDateTime(int pos);

    // /**
    //  * Get {@link java.time.OffsetTime} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // OffsetTime getOffsetTime(int pos);

    // /**
    //  * Get {@link java.time.OffsetDateTime} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // OffsetDateTime getOffsetDateTime(int pos);

    // /**
    //  * Get {@link java.util.UUID} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // UUID getUUID(int pos);

    // /**
    //  * Get {@link BigDecimal} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // BigDecimal getBigDecimal(int pos);

    // /**
    //  * Get an array of {@link Integer} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // Integer[] getIntegerArray(int pos);

    // /**
    //  * Get an array of {@link Boolean} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // Boolean[] getBooleanArray(int pos);

    // /**
    //  * Get an array of  {@link Short} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // Short[] getShortArray(int pos);

    // /**
    //  * Get an array of {@link Long} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // Long[] getLongArray(int pos);

    // /**
    //  * Get an array of  {@link Float} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // Float[] getFloatArray(int pos);

    // /**
    //  * Get an array of  {@link Double} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // Double[] getDoubleArray(int pos);

    // /**
    //  * Get an array of  {@link String} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // String[] getStringArray(int pos);

    // /**
    //  * Get an array of  {@link LocalDate} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // LocalDate[] getLocalDateArray(int pos);

    // /**
    //  * Get an array of  {@link LocalTime} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // LocalTime[] getLocalTimeArray(int pos);

    // /**
    //  * Get an array of  {@link OffsetTime} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // OffsetTime[] getOffsetTimeArray(int pos);

    // /**
    //  * Get an array of  {@link LocalDateTime} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // LocalDateTime[] getLocalDateTimeArray(int pos);

    // /**
    //  * Get an array of  {@link OffsetDateTime} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // OffsetDateTime[] getOffsetDateTimeArray(int pos);

    // /**
    //  * Get an array of  {@link Buffer} value at {@code pos}.
    //  *
    //  * @param pos the position
    //  * @return the value or {@code null}
    //  */
    // Buffer[] getBufferArray(int pos);

    // /**
    //  * Get an array of {@link UUID} value at {@code pos}.
    //  *
    //  * @param pos the column
    //  * @return the value or {@code null}
    //  */
    // UUID[] getUUIDArray(int pos);

    /**
     * Get a buffer value at {@code pos}.
     *
     * @param pos the position
     * @return the value or {@code null}
     */
    byte[] getBuffer(int pos);

    // /**
    //  * Add a boolean value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addBoolean(Boolean value);

    /**
     * Add an object value at the end of the tuple.
     *
     * @param value the value
     * @return a reference to this, so the API can be used fluently
     */
    Tuple addValue(ref Variant value);

    // /**
    //  * Add a short value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addShort(Short value);

    // /**
    //  * Add an integer value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addInteger(Integer value);

    // /**
    //  * Add a long value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addLong(Long value);

    // /**
    //  * Add a float value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addFloat(Float value);

    // /**
    //  * Add a double value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addDouble(Double value);

    // /**
    //  * Add a string value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addString(String value);

    // /**
    //  * Add a buffer value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addBuffer(Buffer value);

    // /**
    //  * Add a {@link java.time.temporal.Temporal} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addTemporal(Temporal value);

    // /**
    //  * Add a {@link java.time.LocalDate} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addLocalDate(LocalDate value);

    // /**
    //  * Add a {@link java.time.LocalTime} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addLocalTime(LocalTime value);

    // /**
    //  * Add a {@link java.time.LocalDateTime} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addLocalDateTime(LocalDateTime value);

    // /**
    //  * Add a {@link java.time.OffsetTime} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addOffsetTime(OffsetTime value);

    // /**
    //  * Add a {@link java.time.OffsetDateTime} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addOffsetDateTime(OffsetDateTime value);

    // /**
    //  * Add a {@link java.util.UUID} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addUUID(UUID value);

    // /**
    //  * Add a {@link BigDecimal} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addBigDecimal(BigDecimal value);

    // /**
    //  * Add an array of {@code Integer} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addIntegerArray(Integer[] value);

    // /**
    //  * Add an array of {@code Boolean} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addBooleanArray(Boolean[] value);

    // /**
    //  * Add an array of {@link Short} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addShortArray(Short[] value);

    // /**
    //  * Add an array of {@link Long} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addLongArray(Long[] value);

    // /**
    //  * Add an array of {@link Float} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addFloatArray(Float[] value);

    // /**
    //  * Add an array of {@link Double} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addDoubleArray(Double[] value);

    // /**
    //  * Add an array of {@link String} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addStringArray(String[] value);

    // /**
    //  * Add an array of {@link LocalDate} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addLocalDateArray(LocalDate[] value);

    // /**
    //  * Add an array of {@link LocalTime} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addLocalTimeArray(LocalTime[] value);

    // /**
    //  * Add an array of {@link OffsetTime} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addOffsetTimeArray(OffsetTime[] value);

    // /**
    //  * Add an array of {@link LocalDateTime} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addLocalDateTimeArray(LocalDateTime[] value);

    // /**
    //  * Add an array of {@link OffsetDateTime} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addOffsetDateTimeArray(OffsetDateTime[] value);

    // /**
    //  * Add an array of {@link Buffer} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addBufferArray(Buffer[] value);

    // /**
    //  * Add an array of {@link UUID} value at the end of the tuple.
    //  *
    //  * @param value the value
    //  * @return a reference to this, so the API can be used fluently
    //  */
    // Tuple addUUIDArray(UUID[] value);

    // <T> T get(Class!(T) type, int pos);

    // <T> T[] getValues(Class!(T) type, int pos);

    // <T> Tuple addValues(T[] value);

    /**
     * @return the tuple size
     */
    int size();

    void clear();

}