modules/schema/src/main/java/org/apache/ignite/internal/schema/NativeTypeSpec.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.ignite.internal.schema;

import org.apache.ignite.internal.tostring.S;

/**
 * Base class for storage built-in data types definition. The class contains predefined values
 * for fixed-sized types and some of the variable-sized types. Parameterized types, such as
 * bitmask of size <code>n</code> bits or number of max n bytes are created using static methods.
 *
 * An instance of native type provides necessary indirection to read any field as an instance of
 * {@code java.lang.Object} to avoid switching inside the row methods.
 */
public enum NativeTypeSpec {
    /**
     * Native type representing a single-byte signed value.
     */
    BYTE("byte", true) {
        /** {@inheritDoc} */
        @Override public Object objectValue(Row tup, int colIdx) {
            return tup.byteValueBoxed(colIdx);
        }
    },

    /**
     * Native type representing a two-bytes signed value.
     */
    SHORT("short", true) {
        /** {@inheritDoc} */
        @Override public Object objectValue(Row tup, int colIdx) {
            return tup.shortValueBoxed(colIdx);
        }
    },

    /**
     * Native type representing a four-bytes signed value.
     */
    INTEGER("integer", true) {
        /** {@inheritDoc} */
        @Override public Object objectValue(Row tup, int colIdx) {
            return tup.intValueBoxed(colIdx);
        }
    },

    /**
     * Native type representing an eight-bytes signed value.
     */
    LONG("long", true) {
        /** {@inheritDoc} */
        @Override public Object objectValue(Row tup, int colIdx) {
            return tup.longValueBoxed(colIdx);
        }
    },

    /**
     * Native type representing a four-bytes floating-point value.
     */
    FLOAT("float", true) {
        /** {@inheritDoc} */
        @Override public Object objectValue(Row tup, int colIdx) {
            return tup.floatValueBoxed(colIdx);
        }
    },

    /**
     * Native type representing an eight-bytes floating-point value.
     */
    DOUBLE("double", true) {
        /** {@inheritDoc} */
        @Override public Object objectValue(Row tup, int colIdx) {
            return tup.doubleValueBoxed(colIdx);
        }
    },

    /**
     * Native type representing a UUID.
     */
    UUID("uuid", true) {
        /** {@inheritDoc} */
        @Override public Object objectValue(Row tup, int colIdx) {
            return tup.uuidValue(colIdx);
        }
    },

    /**
     * Native type representing a string.
     */
    STRING("string") {
        /** {@inheritDoc} */
        @Override public Object objectValue(Row tup, int colIdx) {
            return tup.stringValue(colIdx);
        }
    },

    /**
     * Native type representing an arbitrary byte array.
     */
    BYTES("blob") {
        /** {@inheritDoc} */
        @Override public Object objectValue(Row tup, int colIdx) {
            return tup.bytesValue(colIdx);
        }
    },

    /**
     * Native type representing a bitmask.
     */
    BITMASK("bitmask", true) {
        /** {@inheritDoc} */
        @Override public Object objectValue(Row tup, int colIdx) {
            return tup.bitmaskValue(colIdx);
        }
    };

    /** Flag indicating whether this type specifies a fixed-length type. */
    private final boolean fixedSize;

    /** Single-token type description. */
    private final String desc;

    /**
     * Constructs a varlength type with the given type description.
     *
     * @param desc Type description.
     */
    NativeTypeSpec(String desc) {
        this(desc, false);
    }

    /**
     * Constructs a type with the given description and size.
     *
     * @param desc Type description.
     * @param fixedSize Flag indicating whether this type specifies a fixed-length type.
     */
    NativeTypeSpec(String desc, boolean fixedSize) {
        this.desc = desc;
        this.fixedSize = fixedSize;
    }

    /**
     * @return {@code true} for fixed-length types, {@code false} otherwise.
     */
    public boolean fixedLength() {
        return fixedSize;
    }

    /**
     * Indirection method for getting an Object representation of the given type from the rows. This method
     * does no type conversions and will throw an exception if row column type differs from this
     * type.
     *
     * @param row Row to read the value from.
     * @param colIdx Column index to read.
     * @return An Object representation of the value.
     * @throws InvalidTypeException If this native type differs from the actual type of {@code colIdx}.
     */
    public abstract Object objectValue(Row row, int colIdx) throws InvalidTypeException;

    /** {@inheritDoc} */
    @Override public String toString() {
        return S.toString(NativeTypeSpec.class.getSimpleName(),
            "name", name(),
            "fixed", fixedLength());
    }
}