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

public abstract class POKeyQueryFilter extends POQueryFilter
{
    abstract public boolean isPO_KeyAcceptable( Object pKey );

    protected POKeyQueryFilter( MetaDataForPO pMetaDataForPO )
    {
        super( pMetaDataForPO );
    }

    public static POKeyQueryFilter NONE_ACCEPTABLE = new POKeyQueryFilter( null )
    {
        @Override
        public TYPE getType()
        {
            return TYPE.NoneAcceptable;
        }

        @Override
        public boolean isPO_KeyAcceptable( Object pKey )
        {
            return false;
        }
    };

    public static POKeyQueryFilter ALL_ACCEPTABLE = new POKeyQueryFilter( null )
    {
        @Override
        public TYPE getType()
        {
            return TYPE.AllAcceptable;
        }

        @Override
        public boolean isPO_KeyAcceptable( Object pKey )
        {
            return true;
        }
    };

    public static class Force
    {
        public static POKeyQueryFilter type( POQueryFilter pQueryFilter )
        {
            if ( pQueryFilter instanceof POKeyQueryFilter )
            {
                return (POKeyQueryFilter) pQueryFilter;
            }
            if ( pQueryFilter != null )
            {
                switch ( pQueryFilter.getType() )
                {
                    case NoneAcceptable:
                        return POKeyQueryFilter.NONE_ACCEPTABLE;
                    case AllAcceptable:
                        break;
                    case PotentialFilteringByInstance:
                        throw new IllegalStateException( "PO Query Filter is an Instance Filter" );
                    case PotentialFilteringByKey:
                    default:
                        throw new Error( "Combo of '" + pQueryFilter.getType() + "' and " + pQueryFilter.getClass() );
                }
            }
            return POKeyQueryFilter.ALL_ACCEPTABLE;
        }
    }
}