TransientDirty.java :  » Database-ORM » JPOX » org » jpox » jdo » state » Java Open Source

/**********************************************************************
Copyright (c) 2004 Erik Bengtson and others. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Contributors:
    ...
**********************************************************************/
package org.jpox.jdo.state;

import org.jpox.Transaction;
import org.jpox.StateManager;
import org.jpox.state.LifeCycleState;

/**
 * This class represents TransientDirty state specific state transitions as
 * requested by StateManagerImpl. This state is the result of a wrie operation
 * on a TransientClean instance
 *
 * @version $Revision: 1.3 $ 
 */
class TransientDirty extends LifeCycleState
{
    /**
     * Constructor
     **/
    TransientDirty()
    {
        // these flags are set only in the constructor 
        // and shouldn't be changed afterwards
        // (cannot make them final since they are declared in superclass 
        // but their values are specific to subclasses)
        isPersistent = false;
        isTransactional = true;
        isDirty = true;
        isNew = false;
        isDeleted = false;

        stateType =  T_DIRTY;
    }

    /**
     * @param sm The StateManager 
     * @param useFetchPlan to make transient the fields in the fetch plan
     * @return new LifeCycle state.
     * @see LifeCycleState#transitionMakeTransient(StateManager sm)
     **/
    public LifeCycleState transitionMakeTransient(StateManager sm, boolean useFetchPlan, boolean detachAllOnCommit)
    {
        return this;
    }
 
    /**
     * @param sm The StateManager 
     * @see LifeCycleState#transitionMakePersistent(StateManager sm)
     */
    public LifeCycleState transitionMakePersistent(StateManager sm)
    {
        sm.registerTransactional();
        return changeState(sm,P_NEW);
    }

    /**
     * Method to transition to commit state.
     * @param sm StateManager.
     * @param tx the Transaction been committed.
     * @return new LifeCycle state.
     **/
    public LifeCycleState transitionCommit(StateManager sm, Transaction tx)
    {
      sm.clearSavedFields();
        return changeTransientState(sm,T_CLEAN);
    }
 
    /**
     * @param sm The StateManager
     * @param tx The Transaction 
     * @see LifeCycleState#transitionRollback(StateManagerImpl sm,Transaction tx)
     */
    public LifeCycleState transitionRollback(StateManager sm, Transaction tx)
    {
        if (tx.getRestoreValues() || sm.isRestoreValues())
        {
            sm.restoreFields();
        } // else do nothing.
        return changeTransientState(sm,T_CLEAN); 
    }

    /**
     * Method to return a string version of this object.
     * @return The string "T_DIRTY".
     **/
    public String toString()
    {
        return "T_DIRTY";
    }
}