ColumnType.java example

Explorer
org.eclipse.ecr-master
/*
 * Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Florent Guillaume
 */
package org.eclipse.ecr.core.storage.sql;

import org.eclipse.ecr.core.schema.types.Field;
import org.eclipse.ecr.core.schema.types.SimpleTypeImpl;
import org.eclipse.ecr.core.schema.types.Type;
import org.eclipse.ecr.core.schema.types.primitives.BinaryType;
import org.eclipse.ecr.core.schema.types.primitives.BooleanType;
import org.eclipse.ecr.core.schema.types.primitives.DateType;
import org.eclipse.ecr.core.schema.types.primitives.DoubleType;
import org.eclipse.ecr.core.schema.types.primitives.IntegerType;
import org.eclipse.ecr.core.schema.types.primitives.LongType;
import org.eclipse.ecr.core.schema.types.primitives.StringType;

/**
 * The database-level column types, including per-type parameters like length.
 */
public class ColumnType {

    /** Length used internally to flag a string to use CLOB. */
    public static final int CLOB_LENGTH = 999999999;

    public static final ColumnType STRING = new ColumnType(ColumnSpec.STRING);

    public static final ColumnType CLOB = new ColumnType(ColumnSpec.STRING,
            CLOB_LENGTH);

    public static final ColumnType BOOLEAN = new ColumnType(ColumnSpec.BOOLEAN);

    public static final ColumnType LONG = new ColumnType(ColumnSpec.LONG);

    public static final ColumnType DOUBLE = new ColumnType(ColumnSpec.DOUBLE);

    public static final ColumnType TIMESTAMP = new ColumnType(
            ColumnSpec.TIMESTAMP);

    public static final ColumnType BLOBID = new ColumnType(ColumnSpec.BLOBID);

    public static final ColumnType NODEID = new ColumnType(ColumnSpec.NODEID);

    public static final ColumnType NODEIDFK = new ColumnType(
            ColumnSpec.NODEIDFK);

    public static final ColumnType NODEIDFKNP = new ColumnType(
            ColumnSpec.NODEIDFKNP);

    public static final ColumnType NODEIDFKMUL = new ColumnType(
            ColumnSpec.NODEIDFKMUL);

    public static final ColumnType NODEIDFKNULL = new ColumnType(
            ColumnSpec.NODEIDFKNULL);

    public static final ColumnType NODEIDPK = new ColumnType(
            ColumnSpec.NODEIDPK);

    public static final ColumnType NODEVAL = new ColumnType(ColumnSpec.NODEVAL);

    public static final ColumnType NODEARRAY = new ColumnType(
            ColumnSpec.NODEARRAY);

    public static final ColumnType SYSNAME = new ColumnType(ColumnSpec.SYSNAME);

    public static final ColumnType SYSNAMEARRAY = new ColumnType(
            ColumnSpec.SYSNAMEARRAY);

    public static final ColumnType TINYINT = new ColumnType(ColumnSpec.TINYINT);

    public static final ColumnType INTEGER = new ColumnType(ColumnSpec.INTEGER);

    public static final ColumnType FTINDEXED = new ColumnType(
            ColumnSpec.FTINDEXED);

    public static final ColumnType FTSTORED = new ColumnType(
            ColumnSpec.FTSTORED);

    public static final ColumnType CLUSTERNODE = new ColumnType(
            ColumnSpec.CLUSTERNODE);

    public static final ColumnType CLUSTERFRAGS = new ColumnType(
            ColumnSpec.CLUSTERFRAGS);

    public final ColumnSpec spec;

    public final int length;

    public ColumnType(ColumnSpec spec, int length) {
        this.spec = spec;
        this.length = length;
    }

    public ColumnType(ColumnSpec spec) {
        this(spec, -1);
    }

    public boolean isUnconstrained() {
        return length == -1;
    }

    public boolean isClob() {
        return length == CLOB_LENGTH;
    }

    @Override
    public String toString() {
        if (isUnconstrained()) {
            return spec.toString();
        } else if (isClob()) {
            return "CLOB";
        } else {
            return spec.toString() + '(' + length + ')';
        }
    }

    /**
     * Gets the column type from a Nuxeo Schema field, including its constrained
     * length if any.
     */
    public static ColumnType fromField(Field field) {
        return fromFieldType(field.getType(), field.getMaxLength());
    }

    /**
     * Gets the column type from a Nuxeo Schema field type (unconstrained).
     */
    public static ColumnType fromFieldType(Type type) {
        return fromFieldType(type, -1);
    }

    protected static ColumnType fromFieldType(Type type, int maxLength) {
        if (type instanceof StringType) {
            if (maxLength == -1) {
                return STRING; // unconstrained
            } else {
                return new ColumnType(ColumnSpec.STRING, maxLength);
            }
        } else if (type instanceof BooleanType) {
            return BOOLEAN;
        } else if (type instanceof LongType) {
            return LONG;
        } else if (type instanceof DoubleType) {
            return DOUBLE;
        } else if (type instanceof DateType) {
            return TIMESTAMP;
        } else if (type instanceof BinaryType) {
            return BLOBID;
        } else if (type instanceof IntegerType) {
            return INTEGER;
        } else if (type instanceof SimpleTypeImpl) {
            // comes from a constraint
            return fromFieldType(type.getSuperType(), maxLength);
        } else {
            throw new RuntimeException("Invalid primitive type: "
                    + type.getClass().getName());
        }
    }

}