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

import org.litesoft.commonfoundation.typeutils.*;
import org.litesoft.orsup.base.*;
import org.litesoft.orsup.nonpublic.*;
import org.litesoft.orsup.otherattributeaccessors.*;

public abstract class AbstractLazyLoadTo<Owner extends PersistentObjectImpl, Them extends PersistentObjectImpl>
{
    protected Owner mOwner;
    protected boolean mLoaded = false;

    public AbstractLazyLoadTo( Owner pOwner, AbstractAttributeAccessorSCDtoPO<Owner, Them> pSCDtoPO )
    {
        Objects.assertNotNull( "Owner", mOwner = pOwner );
        Objects.assertNotNull( "AttributeAccessorSCDtoPO", pSCDtoPO );
    }

    abstract public String getAttributeName();

    abstract protected boolean isThemDependantOnUs();

    public final boolean isLoaded()
    {
        return mLoaded;
    }

    public final boolean equals( AbstractLazyLoadTo pThem )
    {
        return (this == pThem) || ((pThem != null) && this.getAttributeName().equals( pThem.getAttributeName() ));
    }

    @Override
    public final boolean equals( Object o )
    {
        return (this == o) || ((o instanceof AbstractLazyLoadTo) && equals( (AbstractLazyLoadTo) o ));
    }

    @Override
    public final int hashCode()
    {
        return getAttributeName().hashCode();
    }

    public void revertToNotLoaded()
    {
        if ( mLoaded )
        {
            mLoaded = false;
            releaseLoadeds();
        }
    }

    abstract protected void releaseLoadeds();

    protected final void checkTransactions( Them pThem )
    {
        if ( !Objects.areNonArraysEqual( pThem.getTransaction(), mOwner.getTransaction() ) )
        {
            throw new IllegalStateException( "We, '" + display( mOwner ) + "' and '" + display( pThem ) + "', are not in the same Transaction" );
        }
    }

    protected MetaDataForPO getPOMetaDataRequired( String pPersistedObjectRegistrationName )
    {
        return getMetaDataForPO().getMetaDataStore().getMetaDataRequired( pPersistedObjectRegistrationName );
    }

    protected MetaDataForPO getMetaDataForPO()
    {
        return mOwner.getMetaDataForPO();
    }

    private String display( PersistentObject<?> pPO )
    {
        return pPO.toString() + ":" + pPO.getPersistentObjectURL();
    }
}