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

import org.litesoft.core.simpletypes.*;
import org.litesoft.core.simpletypes.temporal.*;
import org.litesoft.core.typeutils.*;

public interface BoAttribute
{
    public String getName();

    public AttributeType getType();

    public enum AttributeType
    {
        Primitive_boolean
                {
                    @Override
                    public Class<?> getType()
                    {
                        return Boolean.class;
                    }

                    @Override
                    public boolean isPrimitive()
                    {
                        return true;
                    }

                    @Override
                    public Object normalize( Object pValue, boolean pRequired )
                    {
                        return !Booleans.isBooleanNotTrue( pValue );
                    }

                    @Override
                    public boolean dataNeedsQuoting()
                    {
                        return false;
                    }
                },
        Primitive_int
                {
                    @Override
                    public Class<?> getType()
                    {
                        return Integer.class;
                    }

                    @Override
                    public boolean isPrimitive()
                    {
                        return true;
                    }

                    @Override
                    public boolean dataNeedsQuoting()
                    {
                        return false;
                    }
                },
        Boolean
                {
                    @Override
                    public Class<?> getType()
                    {
                        return Boolean.class;
                    }

                    @Override
                    public Object normalize( Object pValue, boolean pRequired )
                    {
                        return !pRequired ? pValue : !Booleans.isBooleanNotTrue( pValue );
                    }

                    @Override
                    public boolean dataNeedsQuoting()
                    {
                        return false;
                    }
                },
        String
                {
                    @Override
                    public Class<?> getType()
                    {
                        return String.class;
                    }

                    @Override
                    public Object normalize( Object pValue, boolean pRequired )
                    {
                        return Objects.isEmptyString( pValue ) ? null : pValue;
                    }
                },
        Integer
                {
                    @Override
                    public Class<?> getType()
                    {
                        return Integer.class;
                    }

                    @Override
                    public boolean dataNeedsQuoting()
                    {
                        return false;
                    }
                },
        Long
                {
                    @Override
                    public Class<?> getType()
                    {
                        return Long.class;
                    }
                },
        Float
                {
                    @Override
                    public Class<?> getType()
                    {
                        return Float.class;
                    }
                },
        Double
                {
                    @Override
                    public Class<?> getType()
                    {
                        return Double.class;
                    }
                },
        Money
                {
                    @Override
                    public Class<?> getType()
                    {
                        return org.litesoft.core.simpletypes.currency.Money.class;
                    }
                },
        SimpleMoney
                {
                    @Override
                    public Class<?> getType()
                    {
                        return org.litesoft.core.simpletypes.currency.Money.class;
                    }
                },
        Date
                {
                    @Override
                    public Class<?> getType()
                    {
                        return CalendarYMD.class;
                    }
                },
        SimpleDate
                {
                    @Override
                    public Class<?> getType()
                    {
                        return CalendarYMD.class;
                    }
                },
        Time
                {
                    @Override
                    public Class<?> getType()
                    {
                        return SimpleTime.class;
                    }
                },
        SimpleTime
                {
                    @Override
                    public Class<?> getType()
                    {
                        return SimpleTime.class;
                    }
                },
        Timestamp
                {
                    @Override
                    public Class<?> getType()
                    {
                        return SimpleTimestamp.class;
                    }
                },
        SimpleTimestamp
                {
                    @Override
                    public Class<?> getType()
                    {
                        return SimpleTimestamp.class;
                    }
                },
        SimpleFixedPointLong
                {
                    @Override
                    public Class<?> getType()
                    {
                        return FixedPointLong.class;
                    }
                },
        SimpleFloatingPointLong
                {
                    @Override
                    public Class<?> getType()
                    {
                        return FloatingPointLong.class;
                    }
                },
        TextLines
                {
                    @Override
                    public Class<?> getType()
                    {
                        return TextLines.class;
                    }
                };

        /**
         * @return the {@link Class#getName()} of the type
         */
        abstract public Class<?> getType();

        public boolean dataNeedsQuoting()
        {
            return true;
        }

        public boolean isPrimitive()
        {
            return false;
        }

        public Object normalize( Object pValue, boolean pRequired )
        {
            return pValue;
        }
    }
}