org.datanucleus.state.LifeCycleState Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of datanucleus-core Show documentation
Show all versions of datanucleus-core Show documentation
DataNucleus Core provides the primary components of a heterogenous Java persistence solution.
It supports persistence API's being layered on top of the core functionality.
/**********************************************************************
Copyright (c) 2002 Kelly Grizzle (TJDO) 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:
2003 Andy Jefferson - commented
2003 Andy Jefferson - added localiser and Logger
2005 Andy Jefferson - added Detached clean/dirty states
...
**********************************************************************/
package org.datanucleus.state;
import org.datanucleus.FetchPlan;
import org.datanucleus.identity.IdentityUtils;
import org.datanucleus.util.NucleusLogger;
import org.datanucleus.util.Localiser;
/**
* Base Class representing the life cycle state. Implemented for individual states.
*/
public abstract class LifeCycleState
{
/** transient **/
public static final int TRANSIENT = 0;
/** Persistent-New **/
public static final int P_NEW = 1;
/** Persistent-Clean **/
public static final int P_CLEAN = 2;
/** Persistent-Dirty **/
public static final int P_DIRTY = 3;
/** Hollow **/
public static final int HOLLOW = 4;
/** Transaction-Clean **/
public static final int T_CLEAN = 5;
/** Transaction-Dirty **/
public static final int T_DIRTY = 6;
/** Persistent-New-Deleted **/
public static final int P_NEW_DELETED = 7;
/** Persistent-Deleted **/
public static final int P_DELETED = 8;
/** Persistent-NonTransactional **/
public static final int P_NONTRANS = 9;
/** Persistent-NonTransactionalDirty **/
public static final int P_NONTRANS_DIRTY = 10;
/** Detached-Clean **/
public static final int DETACHED_CLEAN = 11;
/** Detached-Dirty **/
public static final int DETACHED_DIRTY = 12;
/** total number of states **/
public static final int TOTAL = 13;
/** illegal state **/
public static final int ILLEGAL_STATE = 13;
// State flags that are set to required valuers in specific state
protected boolean isDirty;
protected boolean isNew;
protected boolean isDeleted;
protected boolean isTransactional;
protected boolean isPersistent;
protected int stateType;
/**
* Returns the type of the life cycle state
* @return the type of this life cycle state
*/
public final int stateType()
{
return stateType;
}
/**
* Utility to change state to a new state.
* @param sm StateManager
* @param newStateType The new state
* @return new LifeCycle state.
*/
protected final LifeCycleState changeState(DNStateManager sm, int newStateType)
{
LifeCycleState newState = sm.getExecutionContext().getNucleusContext().getApiAdapter().getLifeCycleState(newStateType);
if (NucleusLogger.PERSISTENCE.isDebugEnabled())
{
// TODO Cater for embedded cases (id not set, and doesn't show the class)
NucleusLogger.PERSISTENCE.debug(Localiser.msg("027016", IdentityUtils.getPersistableIdentityForId(sm.getInternalObjectId()), this, newState));
}
if (isTransactional)
{
if (newState == null || !newState.isTransactional)
{
sm.evictFromTransaction();
}
}
else
{
if (newState != null && newState.isTransactional)
{
sm.enlistInTransaction();
}
}
if (newState == null)
{
sm.disconnect();
}
return newState;
}
/**
* Utility to change state to a new state.
* @param sm StateManager
* @param newStateType The new state
* @return new LifeCycle state.
*/
protected final LifeCycleState changeTransientState(DNStateManager sm, int newStateType)
{
LifeCycleState newState = sm.getExecutionContext().getNucleusContext().getApiAdapter().getLifeCycleState(newStateType);
try
{
sm.enlistInTransaction();
}
catch (Exception e)
{
//op is already enlisted
}
return newState;
}
/**
* Method to transition to persistent state.
* @param sm StateManager.
* @return new LifeCycle state.
**/
public LifeCycleState transitionMakePersistent(DNStateManager sm)
{
return this;
}
/**
* Method to transition to delete persistent state.
* @param sm StateManager.
* @return new LifeCycle state.
*/
public LifeCycleState transitionDeletePersistent(DNStateManager sm)
{
return this;
}
/**
* Method to transition to transactional state.
* @param sm StateManager.
* @param refreshFields Whether to refresh loaded fields
* @return new LifeCycle state.
*/
public LifeCycleState transitionMakeTransactional(DNStateManager sm, boolean refreshFields)
{
return this;
}
/**
* Method to transition to nontransactional state.
* @param sm StateManager.
* @return new LifeCycle state.
**/
public LifeCycleState transitionMakeNontransactional(DNStateManager sm)
{
return this;
}
/**
* Method to transition to transient state.
* @param sm StateManager.
* @param useFetchPlan to make transient the fields in the fetch plan
* @param detachAllOnCommit Whether to detach on commit
* @return new LifeCycle state.
*/
public LifeCycleState transitionMakeTransient(DNStateManager sm, boolean useFetchPlan, boolean detachAllOnCommit)
{
return this;
}
/**
* Method to transition to transaction begin state.
* @param sm StateManager.
* @param tx Transaction.
* @return new LifeCycle state.
**/
public LifeCycleState transitionBegin(DNStateManager sm, org.datanucleus.transaction.Transaction tx)
{
return this;
}
/**
* Method to transition to commit state.
* @param sm StateManager.
* @param tx the Transaction been committed.
* @return new LifeCycle state.
**/
public LifeCycleState transitionCommit(DNStateManager sm, org.datanucleus.transaction.Transaction tx)
{
return this;
}
/**
* Method to transition to rollback state.
* @param sm StateManager.
* @param tx Transaction.
* @return new LifeCycle state.
**/
public LifeCycleState transitionRollback(DNStateManager sm, org.datanucleus.transaction.Transaction tx)
{
return this;
}
/**
* Method to transition to refresh state.
* @param sm StateManager.
* @return new LifeCycle state.
**/
public LifeCycleState transitionRefresh(DNStateManager sm)
{
return this;
}
/**
* Method to transition to evict state.
* @param sm StateManager.
* @return new LifeCycle state.
**/
public LifeCycleState transitionEvict(DNStateManager sm)
{
return this;
}
/**
* Method to transition to read-field state.
* @param sm StateManager.
* @param isLoaded if the field was previously loaded
* @return new LifeCycle state.
**/
public LifeCycleState transitionReadField(DNStateManager sm, boolean isLoaded)
{
return this;
}
/**
* Method to transition to write-field state.
* @param sm StateManager.
* @return new LifeCycle state.
**/
public LifeCycleState transitionWriteField(DNStateManager sm)
{
return this;
}
/**
* Method to transition to retrieve state.
* @param sm StateManager.
* @param fgOnly only retrieve the current fetch group fields
* @return new LifeCycle state.
**/
public LifeCycleState transitionRetrieve(DNStateManager sm, boolean fgOnly)
{
return this;
}
/**
* Method to transition to retrieve state.
* @param sm StateManager.
* @param fetchPlan the fetch plan to load fields
* @return new LifeCycle state.
**/
public LifeCycleState transitionRetrieve(DNStateManager sm, FetchPlan fetchPlan)
{
return this;
}
/**
* Method to transition to detached-clean.
* @param sm StateManager.
* @return new LifeCycle state.
**/
public LifeCycleState transitionDetach(DNStateManager sm)
{
return this;
}
/**
* Method to transition to persistent-clean.
* @param sm StateManager.
* @return new LifeCycle state.
**/
public LifeCycleState transitionAttach(DNStateManager sm)
{
return this;
}
/**
* Method to transition when serialised.
* @param sm StateManager
* @return The new LifeCycle state
*/
public LifeCycleState transitionSerialize(DNStateManager sm)
{
return this;
}
/**
* Return whether the object is dirty, ie has been changed (created, updated, deleted) in this Tx.
* @return Whether the object is dirty.
*/
public final boolean isDirty()
{
return isDirty;
}
/**
* Return whether the object was newly created.
* @return Whether the object is new.
*/
public final boolean isNew()
{
return isNew;
}
/**
* Return whether the object is deleted.
* @return Whether the object is deleted.
*/
public final boolean isDeleted()
{
return isDeleted;
}
/**
* Return whether the object is transactional.
* @return Whether the object is transactional.
*/
public final boolean isTransactional()
{
return isTransactional;
}
/**
* Return whether the object is persistent.
* @return Whether the object is persistent.
*/
public final boolean isPersistent()
{
return isPersistent;
}
/**
* Method to return a string version of this object.
* @return String version of the object.
**/
public abstract String toString();
}