// 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.*;

public abstract class AbstractNonTransactionalFinder<FT extends NonTransactionalFinder> extends AbstractFinder implements NonTransactionalFinder<FT>
{
    protected AbstractNonTransactionalFinder( ORFacilitatorInternalExtension pCommonSupport, boolean pIncludingImmortalInactives, POQueryFilterFactory pPOQueryFilterFactory )
    {
        super( pCommonSupport, LOGGER, pIncludingImmortalInactives, pPOQueryFilterFactory );
    }

    abstract protected FT create( boolean pIncludingImmortalInactives );

    @SuppressWarnings({"unchecked"}) @Override
    public final FT includeImmortalInactives()
    {
        return isIncludingImmortalInactives() ? (FT) this : create( true );
    }

    @SuppressWarnings({"unchecked"}) @Override
    public final FT excludeImmortalInactives()
    {
        return isIncludingImmortalInactives() ? create( false ) : (FT) this;
    }

    @Override
    public NonTransactionalFinder getNonTransactionalFinder()
    {
        return this;
    }

    /**
     * @param pPersistedObjectRegistrationName
     *                              - Persisted Object Class Name (getClass().getName())
     * @param pSelectionWhereClause - null means all
     * @param pOrderBy              - null means order immaterial
     *
     * @return An Iterator (!Null) that will manage the underlying ResultSet (& DBConnection) creating PO Keys as it goes
     *
     * @throws IllegalStateException         - if the underlying 'set' POQueryFilter is not an POKeyQueryFilter
     * @throws UnsupportedOperationException - if the PO type does not have a "single" key
     * @throws DBException                   - other Exception regarding the OR layer
     */
    @Override
    public final POKeyIterator findAllKeysCursored( String pPersistedObjectRegistrationName, WhereClause pSelectionWhereClause, OrderBy pOrderBy )
            throws IllegalStateException, UnsupportedOperationException, DBException
    {
        return LLfindAllKeysCursored( pPersistedObjectRegistrationName, pSelectionWhereClause, pOrderBy );
    }

    /**
     * @param pPersistedObjectClass - Persisted Object Class (getClass())
     * @param pSelectionWhereClause - null means all
     * @param pOrderBy              - null means order immaterial
     *
     * @return An Iterator (!Null) that will manage the underlying ResultSet (& DBConnection) creating PO Keys as it goes
     *
     * @throws IllegalStateException         - if the underlying 'set' POQueryFilter is not an POKeyQueryFilter
     * @throws UnsupportedOperationException - if the PO type does not have a "single" key
     * @throws DBException                   - other Exception regarding the OR layer
     */
    @Override
    public final POKeyIterator findAllKeysCursored( Class<? extends PersistentObject> pPersistedObjectClass, WhereClause pSelectionWhereClause, OrderBy pOrderBy )
            throws IllegalStateException, UnsupportedOperationException, DBException
    {
        return findAllKeysCursored( pPersistedObjectClass.getName(), pSelectionWhereClause, pOrderBy );
    }

    /**
     * @param pPersistedObjectRegistrationName
     *                              - Persisted Object Class Name (getClass().getName())
     * @param pSelectionWhereClause - null means all
     *
     * @return An Iterator (!Null) that will manage the underlying ResultSet (& DBConnection) creating PO Keys as it goes
     *
     * @throws IllegalStateException         - if the underlying 'set' POQueryFilter is not an POKeyQueryFilter
     * @throws UnsupportedOperationException - if the PO type does not have a "single" key
     * @throws DBException                   - other Exception regarding the OR layer
     */
    @Override
    public final POKeyIterator findAllKeysCursored( String pPersistedObjectRegistrationName, WhereClause pSelectionWhereClause )
            throws IllegalStateException, UnsupportedOperationException, DBException
    {
        return findAllKeysCursored( pPersistedObjectRegistrationName, pSelectionWhereClause, null );
    }

    /**
     * @param pPersistedObjectClass - Persisted Object Class (getClass())
     * @param pSelectionWhereClause - null means all
     *
     * @return An Iterator (!Null) that will manage the underlying ResultSet (& DBConnection) creating PO Keys as it goes
     *
     * @throws IllegalStateException         - if the underlying 'set' POQueryFilter is not an POKeyQueryFilter
     * @throws UnsupportedOperationException - if the PO type does not have a "single" key
     * @throws DBException                   - other Exception regarding the OR layer
     */
    @Override
    public final POKeyIterator findAllKeysCursored( Class<? extends PersistentObject> pPersistedObjectClass, WhereClause pSelectionWhereClause )
            throws IllegalStateException, UnsupportedOperationException, DBException
    {
        return findAllKeysCursored( pPersistedObjectClass.getName(), pSelectionWhereClause, null );
    }

    /**
     * @param pPersistedObjectRegistrationName
     *                              - Persisted Object Class Name (getClass().getName())
     * @param pSelectionWhereClause - null means all
     * @param pOrderBy              - null means order immaterial
     *
     * @return An Iterator (!Null) that will manage the underlying ResultSet (& DBConnection) creating POs as it goes
     *
     * @throws DBException - Exception regarding the OR layer
     */
    @Override
    public final POQueryIterator findAllCursored( String pPersistedObjectRegistrationName, WhereClause pSelectionWhereClause, OrderBy pOrderBy )
            throws DBException
    {
        return LLfindAllCursored( pPersistedObjectRegistrationName, pSelectionWhereClause, pOrderBy );
    }

    /**
     * @param pPersistedObjectClass - Persisted Object Class (getClass())
     * @param pSelectionWhereClause - null means all
     * @param pOrderBy              - null means order immaterial
     *
     * @return An Iterator (!Null) that will manage the underlying ResultSet (& DBConnection) creating POs as it goes
     *
     * @throws DBException - Exception regarding the OR layer
     */
    @SuppressWarnings({"unchecked"}) @Override
    public final <T extends PersistentObject> POQueryIterator<T> findAllCursored( Class<T> pPersistedObjectClass, WhereClause pSelectionWhereClause, OrderBy pOrderBy )
            throws DBException
    {
        return (POQueryIterator<T>) findAllCursored( pPersistedObjectClass.getName(), pSelectionWhereClause, pOrderBy );
    }

    /**
     * @param pPersistedObjectRegistrationName
     *                              - Persisted Object Class Name (getClass().getName())
     * @param pSelectionWhereClause - null means all
     *
     * @return An Iterator (!Null) that will manage the underlying ResultSet (& DBConnection) creating POs as it goes
     *
     * @throws DBException - Exception regarding the OR layer
     */
    @Override
    public final POQueryIterator findAllCursored( String pPersistedObjectRegistrationName, WhereClause pSelectionWhereClause )
            throws DBException
    {
        return findAllCursored( pPersistedObjectRegistrationName, pSelectionWhereClause, null );
    }

    /**
     * @param pPersistedObjectClass - Persisted Object Class (getClass())
     * @param pSelectionWhereClause - null means all
     *
     * @return An Iterator (!Null) that will manage the underlying ResultSet (& DBConnection) creating POs as it goes
     *
     * @throws DBException - Exception regarding the OR layer
     */
    @SuppressWarnings({"unchecked"}) @Override
    public final <T extends PersistentObject> POQueryIterator<T> findAllCursored( Class<T> pPersistedObjectClass, WhereClause pSelectionWhereClause )
            throws DBException
    {
        return (POQueryIterator<T>) findAllCursored( pPersistedObjectClass.getName(), pSelectionWhereClause );
    }

    /**
     * @param pPersistedObject - Persisted Object to be freshly read
     *
     * @return latest version of pPersistedObject, or Null if pPersistedObject is null OR has been deleted
     *
     * @throws DBException - Exception regarding the OR layer
     */
    @Override
    public <T extends PersistentObject> T refresh( PersistentObject<T> pPersistedObject )
            throws DBException
    {
        // todo: Caches
        //noinspection unchecked
        return pPersistedObject == null ? null : (T) findOne( pPersistedObject.getPersistentObjectURL() );
    }

    protected final POKeyIterator LLfindAllKeysCursored( String pPersistedObjectRegistrationName, //
                                                         WhereClause pSelectionWhereClause, OrderBy pOrderBy )
            throws IllegalStateException, UnsupportedOperationException, DBException
    {
        MetaDataForPOinternalExtension metaDataForPO = getRequiredMetaDataForPO( pPersistedObjectRegistrationName );
        POKeyQueryFilter zKeyFilter = POKeyQueryFilter.Force.type( createPOQueryFilter( metaDataForPO ) );
        ORPersistenceHelper helper = (ORPersistenceHelper) getPersistenceHelper();
        return helper.findAllKeysCursored( zKeyFilter, isIncludingImmortalInactives(), metaDataForPO, //
                                           getKeyCD( metaDataForPO, ", so can't findAllKeys" ), pSelectionWhereClause, pOrderBy );
    }
}