com.googlecode.paradox.metadata.Field 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.metadata;

import com.googlecode.paradox.results.Column;
import com.googlecode.paradox.results.ParadoxType;

import java.util.Objects;

/**
 * Generic field definition.
 *
 * @version 1.2
 * @since 1.6.0
 */
public class Field {

    /**
     * Field name.
     */
    protected String name;

    /**
     * The field precision.
     */
    protected int precision;

    /**
     * The field scale.
     */
    protected int scale;

    /**
     * The field size.
     */
    protected int size;

    /**
     * Paradox field type.
     */
    protected ParadoxType type;

    /**
     * The field owner.
     */
    protected Table table;

    /**
     * Stores the field alias.
     */
    protected String alias;

    /**
     * Order of field in table/view. The first value is one.
     */
    protected int orderNum;

    /**
     * The field order.
     */
    protected int realSize;

    /**
     * The field required status.
     */
    protected boolean required;

    /**
     * The picture format.
     */
    protected String picture;

    /**
     * The field default value.
     */
    protected Object defaultValue;

    /**
     * The field min value.
     */
    protected Object minValue;

    /**
     * The field max value.
     */
    protected Object maxValue;

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

    /**
     * Creates a new instance.
     *
     * @param name      The field name.
     * @param precision the field precision.
     * @param scale     the field scale.
     * @param size      the field size.
     * @param type      the field type.
     * @param table     the field table.
     * @param orderNum  the order number.
     */
    public Field(String name, int precision, int scale, int size, ParadoxType type, Table table, int orderNum) {
        this.name = name;
        this.precision = precision;
        this.scale = scale;
        this.size = size;
        this.realSize = size;
        this.type = type;
        this.table = table;
        this.orderNum = orderNum;
    }

    /**
     * Creates a new instance.
     *
     * @param column the column to import from.
     */
    public Field(final Column column) {
        this.name = column.getName();
        this.alias = column.getName();
        this.precision = column.getPrecision();
        this.scale = column.getScale();
        this.size = column.getSize();
        this.realSize = column.getSize();
        this.type = column.getType();
        this.orderNum = column.getIndex();

        if (column.getField() != null) {
            this.precision = column.getField().precision;
            this.size = column.getField().size;
            this.type = column.getField().type;
            this.realSize = column.getField().realSize;
        }
    }

    /**
     * Gets the field alias.
     *
     * @return the field alias.
     */
    public String getAlias() {
        if (this.alias == null) {
            return this.name;
        }

        return this.alias;
    }

    /**
     * Sets the field alias.
     *
     * @param alias the alias to set.
     */
    public void setAlias(final String alias) {
        this.alias = alias;
    }

    /**
     * Gets the field name.
     *
     * @return the field name.
     */
    public String getName() {
        return this.name;
    }

    /**
     * Sets the field name.
     *
     * @param name the name to set.
     */
    public void setName(final String name) {
        this.name = name;
    }

    /**
     * Gets the field size.
     *
     * @return the size.
     */
    public int getSize() {
        return this.size;
    }

    /**
     * Sets the field size.
     *
     * @param size the field size.
     */
    public void setSize(int size) {
        this.size = size;
    }

    /**
     * Gets the field table.
     *
     * @return the field table.
     */
    public Table getTable() {
        return this.table;
    }

    /**
     * Sets the table reference.
     *
     * @param table the table reference.
     */
    public void setTable(final Table table) {
        this.table = table;
    }

    /**
     * Gets the field type.
     *
     * @return the field type.
     */
    public ParadoxType getType() {
        return this.type;
    }

    /**
     * Gets the field precision.
     *
     * @return the field precision.
     */
    public int getPrecision() {
        return precision;
    }

    /**
     * Gets the field scale.
     *
     * @return the field scale.
     */
    public int getScale() {
        return scale;
    }

    /**
     * Gets the field auto increment status.
     *
     * @return true if this field is auto increment.
     */
    public boolean isAutoIncrement() {
        return this.type == ParadoxType.AUTO_INCREMENT;
    }

    /**
     * Gets the SQL field type.
     *
     * @return the SQL field type.
     */
    public int getSqlType() {
        return type.getSQLType();
    }

    /**
     * Gets the field order.
     *
     * @return the field order.
     */
    public int getOrderNum() {
        return this.orderNum;
    }

    /**
     * Sets the field type.
     *
     * @param type the field type.
     */
    public void setType(ParadoxType type) {
        this.type = type;
    }

    /**
     * Gets the file size in file.
     *
     * @return the file size in file.
     */
    public int getRealSize() {
        return this.realSize;
    }

    /**
     * Gets the field required status.
     */
    public boolean isRequired() {
        return required;
    }

    /**
     * Sets the field required status.
     *
     * @param required the field required status.
     */
    public void setRequired(boolean required) {
        this.required = required;
    }

    /**
     * Gets the picture format.
     *
     * @return the picture format.
     */
    public String getPicture() {
        return picture;
    }

    /**
     * Sets the picture format.
     *
     * @param picture the picture format.
     */
    public void setPicture(String picture) {
        this.picture = picture;
    }

    /**
     * Gets the field default value.
     *
     * @return the field default value.
     */
    public Object getDefaultValue() {
        return defaultValue;
    }

    /**
     * Sets the field default value.
     *
     * @param defaultValue the field default value.
     */
    public void setDefaultValue(Object defaultValue) {
        this.defaultValue = defaultValue;
    }

    /**
     * Gets the field minimum value.
     *
     * @return the field minimum value.
     */
    public Object getMinValue() {
        return minValue;
    }

    /**
     * Sets the field minimum value.
     *
     * @param minValue the field minimum value.
     */
    public void setMinValue(Object minValue) {
        this.minValue = minValue;
    }

    /**
     * Sets the field maximum value.
     *
     * @return the field maximum value.
     */
    public Object getMaxValue() {
        return maxValue;
    }

    /**
     * Sets the field maximum value.
     *
     * @param maxValue the field maximum value.
     */
    public void setMaxValue(Object maxValue) {
        this.maxValue = maxValue;
    }

    @Override
    public String toString() {
        return name;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }

        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        Field field = (Field) o;
        return Objects.equals(name, field.name) &&
                Objects.equals(table, field.table) &&
                Objects.equals(alias, field.alias);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, table, alias);
    }
}