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

import org.litesoft.db.*;
import org.litesoft.orsup.base.*;
import org.litesoft.orsup.selection.*;
import org.litesoft.orsup.transact.*;

public class UnfilteringFinderImpl extends AbstractNonTransactionalFinder<UnfilteringFinder> implements UnfilteringFinder
{
    protected UnfilteringFinderImpl( ORFacilitatorInternalExtension pCommonSupport, boolean pIncludingImmortalInactives )
    {
        super( pCommonSupport, pIncludingImmortalInactives, null );
    }

    @Override
    protected UnfilteringFinder create( boolean pIncludingImmortalInactives )
    {
        return new UnfilteringFinderImpl( this, pIncludingImmortalInactives );
    }

    @Override
    public final Transaction createUnaugmentedTransaction()
    {
        return getTransactionFactory().createTransaction( this, false );
    }

    /**
     * @param pPersistedObjectRegistrationName
     *                              - Persisted Object Class Name (getClass().getName())
     * @param pSelectionWhereClause - null means all
     *
     * @throws DBException - Exception regarding the OR layer
     */
    @Override
    public final long count( String pPersistedObjectRegistrationName, WhereClause pSelectionWhereClause )
            throws DBException
    {
        ORPersistenceHelper helper = (ORPersistenceHelper) getPersistenceHelper();
        MetaDataForPO metaDataForPO = getRequiredMetaDataForPO( pPersistedObjectRegistrationName );
        return helper.count( isIncludingImmortalInactives(), metaDataForPO, pSelectionWhereClause );
    }

    /**
     * @param pPersistedObjectClass - Persisted Object Class (getClass())
     * @param pSelectionWhereClause - null means all
     *
     * @throws DBException - Exception regarding the OR layer
     */
    @Override
    public final long count( Class<? extends PersistentObject> pPersistedObjectClass, WhereClause pSelectionWhereClause )
            throws DBException
    {
        return count( pPersistedObjectClass.getName(), pSelectionWhereClause );
    }

    /**
     * @param pPersistedObjectRegistrationName
     *                              - Persisted Object Class Name (getClass().getName())
     * @param pSelectionWhereClause - null means any will do
     * @param pOrderBy              - null means order immaterial
     * @param pUpdateValuePairs     - additional columns to set
     *
     * @return 'snaged' PO or Null if no POs available to be 'snaged'
     *
     * @throws UnsupportedOperationException - if the PO type does not support 'snaging'
     * @throws DBException                   - Exception regarding the OR layer
     */
    @Override
    public final PersistentObject<?> snagOne( String pPersistedObjectRegistrationName, WhereClause pSelectionWhereClause, OrderBy pOrderBy, ColumnUpdateValuePair... pUpdateValuePairs )
            throws UnsupportedOperationException, DBException
    {
        MetaDataForPO metaDataForPO = getRequiredMetaDataForPO( pPersistedObjectRegistrationName );
        if ( !metaDataForPO.isSnagable() )
        {
            throw new UnsupportedOperationException( pPersistedObjectRegistrationName + " is not flagged as 'Snaggable'" );
        }
        SimpleColumnDefinition zKeyCD = getKeyCD( metaDataForPO, ", and is therefore not 'Snaggable'" );

        AttributeAccessorSCD zSnagCD = metaDataForPO.getAccessorSCDrequired( metaDataForPO.getSnagAttributeName() );

        Long zUniqueSnagValue = mCommonSupport.getNextSequenceNumber( "Snags" );

        PersistenceHelper helper = getPersistenceHelper();
        if ( !helper.snagOne( metaDataForPO, zKeyCD, zSnagCD, zUniqueSnagValue, pSelectionWhereClause, pOrderBy, pUpdateValuePairs ) )
        {
            return null;
        }
        return findOne( pPersistedObjectRegistrationName, //
                        WhereClauseFactory.INSTANCE.isEqual( zSnagCD, zUniqueSnagValue ) );
    }

    /**
     * @param pPersistedObjectClass - Persisted Object Class (getClass())
     * @param pSelectionWhereClause - null means any will do
     * @param pOrderBy              - null means order immaterial
     * @param pUpdateValuePairs     - additional columns to set
     *
     * @return 'snaged' PO or Null if no POs available to be 'snaged'
     *
     * @throws UnsupportedOperationException - if the PO type does not support 'snaging'
     * @throws DBException                   - Exception regarding the OR layer
     */
    @SuppressWarnings({"unchecked"}) @Override
    public final <T extends PersistentObject> T snagOne( Class<T> pPersistedObjectClass, WhereClause pSelectionWhereClause, OrderBy pOrderBy, ColumnUpdateValuePair... pUpdateValuePairs )
            throws UnsupportedOperationException, DBException
    {
        return (T) snagOne( pPersistedObjectClass.getName(), pSelectionWhereClause, pOrderBy, pUpdateValuePairs );
    }
}