io.deephaven.client.impl.FieldAdapter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of deephaven-java-client-flight Show documentation
The Deephaven client flight library
There is a newer version: 0.37.1
Show newest version
//
// Copyright (c) 2016-2024 Deephaven Data Labs and Patent Pending
//
package io.deephaven.client.impl;

import io.deephaven.qst.column.header.ColumnHeader;
import io.deephaven.qst.type.ArrayType;
import io.deephaven.qst.type.BooleanType;
import io.deephaven.qst.type.BoxedType;
import io.deephaven.qst.type.ByteType;
import io.deephaven.qst.type.CharType;
import io.deephaven.qst.type.CustomType;
import io.deephaven.qst.type.DoubleType;
import io.deephaven.qst.type.FloatType;
import io.deephaven.qst.type.GenericType;
import io.deephaven.qst.type.GenericVectorType;
import io.deephaven.qst.type.InstantType;
import io.deephaven.qst.type.IntType;
import io.deephaven.qst.type.LongType;
import io.deephaven.qst.type.NativeArrayType;
import io.deephaven.qst.type.PrimitiveType;
import io.deephaven.qst.type.PrimitiveVectorType;
import io.deephaven.qst.type.ShortType;
import io.deephaven.qst.type.StringType;
import io.deephaven.qst.type.Type;
import org.apache.arrow.vector.types.TimeUnit;
import org.apache.arrow.vector.types.Types.MinorType;
import org.apache.arrow.vector.types.pojo.ArrowType;
import org.apache.arrow.vector.types.pojo.Field;
import org.apache.arrow.vector.types.pojo.FieldType;

import java.util.Collections;
import java.util.Objects;

/**
 * Utilities for creating a {@link Field}.
 */
public class FieldAdapter implements Type.Visitor, PrimitiveType.Visitor, GenericType.Visitor,
        ArrayType.Visitor {

    /**
     * Convert a {@code header} into a {@link Field}.
     *
     * @param header the header
     * @return the field
     */
    public static Field of(ColumnHeader header) {
        return header.componentType().walk(new FieldAdapter(header.name()));
    }

    public static Field byteField(String name) {
        return field(name, MinorType.TINYINT.getType(), "byte");
    }

    public static Field booleanField(String name) {
        return field(name, MinorType.BIT.getType(), "boolean");
    }

    public static Field charField(String name) {
        return field(name, MinorType.UINT2.getType(), "char");
    }

    public static Field shortField(String name) {
        return field(name, MinorType.SMALLINT.getType(), "short");
    }

    public static Field intField(String name) {
        return field(name, MinorType.INT.getType(), "int");
    }

    public static Field longField(String name) {
        return field(name, MinorType.BIGINT.getType(), "long");
    }

    public static Field floatField(String name) {
        return field(name, MinorType.FLOAT4.getType(), "float");
    }

    public static Field doubleField(String name) {
        return field(name, MinorType.FLOAT8.getType(), "double");
    }

    public static Field stringField(String name) {
        return field(name, MinorType.VARCHAR.getType(), "java.lang.String");
    }

    public static Field byteVectorField(String name) {
        return field(name, MinorType.VARBINARY.getType(), "byte[]");
    }

    public static Field instantField(String name) {
        return field(name, new ArrowType.Timestamp(TimeUnit.NANOSECOND, "UTC"), "java.time.Instant");
    }

    private static Field field(String name, ArrowType arrowType, String deephavenType) {
        return field(name,
                new FieldType(true, arrowType, null, Collections.singletonMap("deephaven:type", deephavenType)));
    }

    private static Field field(String name, FieldType type) {
        return new Field(name, type, null);
    }

    private static UnsupportedOperationException unsupported(Type type) {
        return new UnsupportedOperationException(String.format("Field type '%s' is not supported yet", type));
    }

    private final String name;

    private FieldAdapter(String name) {
        this.name = Objects.requireNonNull(name);
    }

    @Override
    public Field visit(PrimitiveType primitive) {
        return primitive.walk((PrimitiveType.Visitor) this);
    }

    @Override
    public Field visit(ByteType byteType) {
        return byteField(name);
    }

    @Override
    public Field visit(BooleanType booleanType) {
        return booleanField(name);
    }

    @Override
    public Field visit(CharType charType) {
        return charField(name);
    }

    @Override
    public Field visit(ShortType shortType) {
        return shortField(name);
    }

    @Override
    public Field visit(IntType intType) {
        return intField(name);
    }

    @Override
    public Field visit(LongType longType) {
        return longField(name);
    }

    @Override
    public Field visit(FloatType floatType) {
        return floatField(name);
    }

    @Override
    public Field visit(DoubleType doubleType) {
        return doubleField(name);
    }

    // ----------------------------------------------------------

    @Override
    public Field visit(GenericType generic) {
        return generic.walk((GenericType.Visitor) this);
    }

    @Override
    public Field visit(BoxedType boxedType) {
        // same field type as primitives
        return boxedType.primitiveType().walk((PrimitiveType.Visitor) this);
    }

    @Override
    public Field visit(StringType stringType) {
        return stringField(name);
    }

    @Override
    public Field visit(InstantType instantType) {
        return instantField(name);
    }

    @Override
    public Field visit(CustomType customType) {
        throw unsupported(customType);
    }

    // ----------------------------------------------------------

    @Override
    public Field visit(ArrayType arrayType) {
        return arrayType.walk((ArrayType.Visitor) this);
    }

    @Override
    public Field visit(NativeArrayType nativeArrayType) {
        return nativeArrayType.componentType().walk(new NativeArrayVisitor());
    }

    @Override
    public Field visit(PrimitiveVectorType vectorPrimitiveType) {
        throw unsupported(vectorPrimitiveType);
    }

    @Override
    public Field visit(GenericVectorType genericVectorType) {
        throw unsupported(genericVectorType);
    }

    // ----------------------------------------------------------

    final class NativeArrayVisitor
            implements Type.Visitor, PrimitiveType.Visitor, GenericType.Visitor {
        @Override
        public Field visit(PrimitiveType primitiveType) {
            return primitiveType.walk((PrimitiveType.Visitor) this);
        }

        @Override
        public Field visit(BooleanType booleanType) {
            return field(name, MinorType.LIST.getType(), "java.lang.Boolean[]");
        }

        @Override
        public Field visit(ByteType byteType) {
            return byteVectorField(name);
        }

        @Override
        public Field visit(CharType charType) {
            return field(name, MinorType.LIST.getType(), "char[]");
        }

        @Override
        public Field visit(ShortType shortType) {
            return field(name, MinorType.LIST.getType(), "short[]");
        }

        @Override
        public Field visit(IntType intType) {
            return field(name, MinorType.LIST.getType(), "int[]");
        }

        @Override
        public Field visit(LongType longType) {
            return field(name, MinorType.LIST.getType(), "long[]");
        }

        @Override
        public Field visit(FloatType floatType) {
            return field(name, MinorType.LIST.getType(), "float[]");
        }

        @Override
        public Field visit(DoubleType doubleType) {
            return field(name, MinorType.LIST.getType(), "double[]");
        }

        // ----------------------------------------------------------

        @Override
        public Field visit(GenericType genericType) {
            return genericType.walk((GenericType.Visitor) this);
        }

        @Override
        public Field visit(BoxedType boxedType) {
            throw unsupported(boxedType.arrayType());
        }

        @Override
        public Field visit(StringType stringType) {
            return field(name, MinorType.LIST.getType(), "java.lang.String[]");
        }

        @Override
        public Field visit(InstantType instantType) {
            return field(name, MinorType.LIST.getType(), "java.time.Instant[]");
        }

        @Override
        public Field visit(ArrayType arrayType) {
            throw unsupported(arrayType.arrayType());
        }

        @Override
        public Field visit(CustomType customType) {
            throw unsupported(customType.arrayType());
        }
    }
}