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

import org.litesoft.logger.*;

public abstract class POQueryFilter
{
    public static final Logger LOGGER = LoggerFactory.getLogger( POQueryFilter.class );

    public enum TYPE
    {
        NoneAcceptable,
        AllAcceptable,
        PotentialFilteringByKey,
        PotentialFilteringByInstance
    }

    private MetaDataForPO mMetaDataForPO;

    protected POQueryFilter( MetaDataForPO pMetaDataForPO )
    {
        mMetaDataForPO = pMetaDataForPO;
    }

    /**
     * @return Filtering on PO MetaData or null: null indicates that there is either No Filtering or that No POs would pass the filter.
     */
    public MetaDataForPO getMetaDataForPO()
    {
        return mMetaDataForPO;
    }

    abstract public TYPE getType();

    @Override
    public String toString()
    {
        return getClass().getSimpleName() + " " + getType() + " on " + getMetaDataForPO();
    }

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

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