// This Source Code is in the Public Domain per: http://litesoft.org/License.txt
package org.litesoft.db;

import org.litesoft.commonfoundation.typeutils.*;

public class DBtableColumn
{
    private String mColumnName;
    private int mSqlType; // See java.sql.Types
    private Integer mColumnSize; // For char or date types this is the maximum number of characters, for numeric or decimal types this is precision.
    private Integer mDecimalDigits; // the number of fractional digits
    private Boolean mNullable; // False - might not allow NULL values; True - definitely allows NULL values; null - nullability unknown

    public DBtableColumn( String pColumnName, int pSqlType, Integer pColumnSize, Integer pDecimalDigits, Boolean pNullable )
    {
        mColumnName = Strings.assertNotNullNotEmpty( "ColumnName", pColumnName );
        mSqlType = pSqlType;
        mColumnSize = pColumnSize;
        mDecimalDigits = pDecimalDigits;
        mNullable = pNullable;
    }

    public String getColumnName()
    {
        return mColumnName;
    }

    /**
     * @return See java.sql.Types
     */
    public int getSqlType()
    {
        return mSqlType;
    }

    /**
     * @return if !null - For char or date types this is the maximum number of characters, for numeric or decimal types this is precision.
     */
    public Integer getColumnSize()
    {
        return mColumnSize;
    }

    /**
     * @return if !null - the number of fractional digits
     */
    public Integer getDecimalDigits()
    {
        return mDecimalDigits;
    }

    /**
     * @return False - might not allow NULL values; True - definitely allows NULL values; null - nullability unknown
     */
    public Boolean getNullable()
    {
        return mNullable;
    }

    @Override
    public String toString()
    {
        StringBuilder sb = new StringBuilder();
        sb.append( mColumnName ).append( " (" ).append( mSqlType ).append( ')' );
        if ( mNullable != null )
        {
            if ( mNullable )
            {
                sb.append( " Nullable" );
            }
            else
            {
                sb.append( " ~!Nullable~" );
            }
        }
        if ( (mColumnSize != null) || (mDecimalDigits != null) )
        {
            sb.append( " (" ).append( mColumnSize );
            if ( mDecimalDigits != null )
            {
                sb.append( ',' ).append( mDecimalDigits );
            }
            sb.append( ')' );
        }
        return sb.toString();
    }
}