net.java.ao.schema.ddl.DDLField Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of activeobjects Show documentation
This is the full Active Objects library, if you don't know which one to use, you probably want this one.
The newest version!
/*
 * Copyright 2007 Daniel Spiewak
 * 
 * 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.
 */
package net.java.ao.schema.ddl;

import net.java.ao.types.TypeInfo;

/**
 * Database-agnostic representation of a field within a table containing
 * all associated attributes such as type and constraints.  The only
 * field-relative attribute not contained within this class is whether
 * or not the field is indexed at the database level.
 *
 * @author Daniel Spiewak
 */
public class DDLField {
    private String name;

    private TypeInfo type;
    private int jdbcType;

    private boolean primaryKey;
    private boolean autoIncrement;
    private boolean notNull;
    private boolean unique;

    private Object defaultValue;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public TypeInfo getType() {
        return type;
    }

    public void setType(TypeInfo type) {
        this.type = type;
    }

    public int getJdbcType() {
        return jdbcType;
    }

    public void setJdbcType(int jdbcType) {
        this.jdbcType = jdbcType;
    }

    public boolean isPrimaryKey() {
        return primaryKey;
    }

    public void setPrimaryKey(boolean primaryKey) {
        this.primaryKey = primaryKey;
    }

    public boolean isAutoIncrement() {
        return autoIncrement;
    }

    public void setAutoIncrement(boolean autoIncrement) {
        this.autoIncrement = autoIncrement;
    }

    public boolean isNotNull() {
        return notNull;
    }

    public void setNotNull(boolean notNull) {
        this.notNull = notNull;
    }

    public boolean isUnique() {
        return unique;
    }

    public void setUnique(boolean unique) {
        this.unique = unique;
    }

    public Object getDefaultValue() {
        return defaultValue;
    }

    public void setDefaultValue(Object defaultValue) {
        this.defaultValue = defaultValue;
    }

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

    @Override
    public int hashCode() {
        int back = type.hashCode();

        if (name != null) {
            back += name.hashCode();
        }

        return back;
    }

    @Override
    public boolean equals(Object obj) {
        if (obj instanceof DDLField) {
            DDLField field = (DDLField) obj;
            if (field == this) {
                return true;
            }

            if ((field.getName() == null || field.getName().equals(name))
                    && field.getType() == type) {
                return true;
            }

            return false;
        }

        return super.equals(obj);
    }
}