Column.java

/*
 * JBoss, Home of Professional Open Source.
 *
 * See the LEGAL.txt file distributed with this work for information regarding copyright ownership and licensing.
 *
 * See the AUTHORS.txt file distributed with this work for a full listing of individual contributors.
 */
package org.teiid.designer.transformation.reverseeng.api;

import java.util.HashMap;
import java.util.Map;

import org.teiid.designer.transformation.reverseeng.util.StringBuilderUtil;


/**
 * @author vanhalbert
 *
 */
public class Column  {
	
	public enum NullType {
		No_Nulls {
			@Override
			public String toString() {
				return "No Nulls"; //$NON-NLS-1$
			}
		},
		Nullable,
		Unknown		
	}
	
	private Table parent;

    private String name;
    
    /**
     * The converted name for camel case
     */
    private String memberName;
    
    /**
     * Defines java sql type of the column.
     */
    private int type = java.sql.Types.VARCHAR;
    
    private String javaType = null;
    
    private String typeName = "";
    
    /**
     * Defines whether the attribute is indexed
     */
    private boolean isIndexed;

    // The length of CHAR or VARCHAr or max num of digits for DECIMAL.
    private int maxLength = -1;

    private int scale = -1;

    private int precision = -1;
    
    private String defaultValue = null;

    private NullType nullType;
    
    private String remarks;    
    
    private int order;
    
    private boolean required;


    public Column(Table parent, String name) {
    	this.parent = parent;
    	this.name = name;
    	memberName = org.teiid.designer.transformation.reverseeng.util.Util.columnNameToMemberName(this.name);
    }
    
    public Table getParent() {
    	return parent;
    }
    
    public String getName() {
        return name;
    }
    
	public String getAliasedName(String alias) {
        return (alias != null) ? alias + '.' + this.getName() : this.getName();
    }
    
    public String getMemberName() {
    	return memberName;
    }
    
    public int getType() {
        return type;
    }

    public void setType(int type) {
        this.type = type;
        
        this.javaType = TypesMapping.getJavaBySqlType(type);
    }   
    
    public String getJavaType() {
    	return this.javaType;
    }
    
    public void setJavaType(String javaType) {
    	this.javaType = javaType;
    }
    
	public String getTypeName() {
		return typeName;
	}

	public void setTypeName(String typeName) {
		this.typeName = typeName;
	}
    
	public String getDefaultValue() {
		return defaultValue;
	}

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

	public boolean isIndexed() {
        return isIndexed;
    }

    public void setIsIndexed(boolean indexed) {
    	this.isIndexed = indexed;
    }
    
    /**
     * isRequired indicates if the column is required due to a defined unique or primary key
     * @return boolean <code> true </code> if this column is required
     */
	public boolean isRequired() {
        return required;
    }

    public void setIsRequired(boolean isrequired) {
    	this.required = isrequired;
    }

	public int getPrecision() {
		return precision;
	}

	public void setPrecision(int precision) {
		this.precision = precision;
	}
    
	/**
     * isMandatory indicates if the column is support NULL's or not.  A <code> true </code>
     * value would indicate this column does NOT support a NULL value.
     * @return boolean <code> true </code> if this column does not support NULLs
     */
    public boolean isMandatory() {
        return (nullType == NullType.No_Nulls ? true : false);
    }

	public String getRemarks() {
		return remarks;
	}

	public void setRemarks(String remarks) {
		this.remarks = remarks;
	}

	public NullType getNullType() {
		return nullType;
	}


	public void setNullType(NullType nullType) {
		this.nullType = nullType;
	}

    public int getMaxLength() {
        return maxLength;
    }

    /**
     * Sets the length of character or binary type or max num of digits for
     * DECIMAL.
     * @param maxLength 
     */
    public void setMaxLength(int maxLength) {
        this.maxLength = maxLength;
    }

    public int getScale() {
        return scale;
    }

    public void setScale(int scale) {
        this.scale = scale;
    }
    
    public int getOrder() {
    	return order;
    }
    
    public void setOrder(int order) {
    	this.order = order;
    }
    
    @Override
	public String toString() {
    	StringBuilderUtil sbu = new StringBuilderUtil(this).append("name", getName());
 //       String type = TypesMapping.getSqlNameByType(getType());

        sbu.append("DBColumn", "type [" + getTypeName() + "]");
       
        if (scale > -1 || precision > -1) {
        	 sbu.append("scale", "[" + scale + ", " + precision + "]");
        }

        if (maxLength > -1) {
        	sbu.append("maxLength", "[" + maxLength + "]");
        }

        if (isIndexed) {
        	sbu.append("isIndexed", "[" + isIndexed + "]");
            
        } else if (isMandatory()) {
        	sbu.append("Mandatory", "[" + isMandatory() + "]");
        }

        return sbu.toString();
    }   
    
    

    
//	public abstract String getAliasedName();
    
    
	/**
	 * {@inheritDoc}
	 *
	 * @see java.lang.Object#equals(java.lang.Object)
	 */
	@Override
	public boolean equals(Object obj) {
		Column c = (Column) obj;
		if (this == obj) return true;
		if (this.getParent() == null && c.getParent() != null) return false;
		if (this.getParent() != null && c.getParent() == null) return false;
		
		if (this.getParent() != null && c.getParent() != null) {
			if (!this.getParent().getName().equals(c.getParent().getName())) {
				return false;
			}
									
		}
		
		if (this.getName().equals(c.getName()) &&
				this.getType() == c.getType() &&
				this.getPrecision() == c.getPrecision() &&
				this.getScale() == c.getScale() &&
				this.isIndexed() == c.isIndexed() &&
				this.isMandatory() == c.isMandatory() ) {
					return true;
		}

		return false;
	}

	/**
	 * @return typeName
	 */
//	public abstract String getTypeName();


}