/**********************************************************************
Copyright (c) 2002 Kelly Grizzle 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:
2002 Mike Martin - unknown changes
2003 Andy Jefferson - commented
2003 Andy Jefferson - added localiser
...
**********************************************************************/
package org.jpox.jpa.state;
import org.jpox.Transaction;
import org.jpox.exceptions.JPOXUserException;
import org.jpox.state.LifeCycleState;
import org.jpox.StateManager;
/**
* Class representing the life cycle state of PersistentDirty
*
* @version $Revision: 1.7 $
**/
class PersistentDirty extends LifeCycleState
{
protected PersistentDirty()
{
isPersistent = true;
isDirty = true;
isNew = false;
isDeleted = false;
isTransactional = true;
stateType = P_DIRTY;
}
/**
* Method to transition to delete-persistent
* @param sm StateManager.
* @return new LifeCycle state.
**/
public LifeCycleState transitionDeletePersistent(StateManager sm)
{
return changeState(sm, P_DELETED);
}
/**
* Method to transition to nontransactional.
* @param sm StateManager.
* @return new LifeCycle state.
*/
public LifeCycleState transitionMakeNontransactional(StateManager sm)
{
throw new JPOXUserException(LOCALISER.msg("027011"), sm.getInternalObjectId());
}
/**
* Method to transition to transient.
* @param sm StateManager.
* @param useFetchPlan to make transient the fields in the fetch plan
* @return new LifeCycle state.
*/
public LifeCycleState transitionMakeTransient(StateManager sm, boolean useFetchPlan, boolean detachAllOnCommit)
{
if (detachAllOnCommit)
{
return changeState(sm, TRANSIENT);
}
throw new JPOXUserException(LOCALISER.msg("027012"),sm.getInternalObjectId());
}
/**
* 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();
if (tx.getRetainValues())
{
return changeState(sm, P_NONTRANS);
}
else
{
sm.clearNonPrimaryKeyFields();
return changeState(sm, HOLLOW);
}
}
/**
* Method to transition to rollback state.
* @param sm StateManager.
* @param tx The transaction
* @return new LifeCycle state.
**/
public LifeCycleState transitionRollback(StateManager sm, Transaction tx)
{
if (tx.getRestoreValues())
{
sm.restoreFields();
return changeState(sm, P_NONTRANS);
}
else
{
sm.clearNonPrimaryKeyFields();
sm.clearSavedFields();
return changeState(sm, HOLLOW);
}
}
/**
* Method to transition to refresh state.
* @param sm StateManager.
* @return new LifeCycle state.
**/
public LifeCycleState transitionRefresh(StateManager sm)
{
sm.clearSavedFields();
// Refresh the FetchPlan fields and unload all others
sm.refreshFieldsInFetchPlan();
sm.unloadNonFetchPlanFields();
Transaction tx = sm.getObjectManager().getTransaction();
if (tx.isActive() && !tx.getOptimistic())
{
return changeState(sm,P_CLEAN);
}
return changeState(sm,P_NONTRANS);
}
/**
* Method to transition to detached-clean.
* @param sm StateManager.
* @return new LifeCycle state.
**/
public LifeCycleState transitionDetach(StateManager sm)
{
return changeState(sm, DETACHED_CLEAN);
}
/**
* Method to return a string version of this object.
* @return The string "P_DIRTY".
**/
public String toString()
{
return "P_DIRTY";
}
}