ManagedInstance (Batoo Persistence Core 0.1.2 API)

java.lang.Object
- org.batoo.jpa.core.impl.instance.ManagedInstance<X>

Type Parameters:
X - the type of the managed instance
```
public class ManagedInstance<X>
extends Object
```
The managed instance to track entity instances.

Since:

$version

Author:

hceylan

Field Summary

Fields
Modifier and Type Field and Description

static ThreadLocal<LockModeType> LOCK_CONTEXT
The current lock mode context.

Fields
Modifier and Type	Field and Description
`static ThreadLocal<LockModeType>`	`LOCK_CONTEXT` The current lock mode context.

Constructor Summary

Constructors
Constructor and Description
`ManagedInstance(EntityTypeImpl<X> type, SessionImpl session, X instance)`
`ManagedInstance(EntityTypeImpl<X> type, SessionImpl session, X instance, ManagedId<? super X> id)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`cascadeDetach(EntityManagerImpl entityManager)` Cascades the detach operation.
`boolean`	`cascadePersist(EntityManagerImpl entityManager, ArrayList<Object> processed)` Cascades the persist operation.
`void`	`cascadeRemove(EntityManagerImpl entityManager)` Cascades the remove operation
`void`	`changed()` Marks the instance as may have changed.
`void`	`checkTransients()` Checks that no association of the instance is transient
`void`	`checkUpdated()` Checks if the instance updated.
`void`	`checkVersion(ConnectionImpl connection)` Checks the optimistic lock for the instance.
`void`	`enhanceCollections()` Enhances the collections of the managed instance.
`boolean`	`equals(Object obj)`
`boolean`	`fillIdValues()` Fills the sequence / table generated values.
`void`	`fireCallbacks(EntityListenerMetadata.EntityListenerType type)` Fires the callbacks.
`void`	`flush(ConnectionImpl connection)` Flushes the state of the instance to the database.
`void`	`flushAssociations(ConnectionImpl connection, boolean removals, boolean force)` Flushes the associations.
`HashSet<JoinedMapping<?,?,?>>`	`getAssociationsLoaded()` Returns the associations that are loaded.
`ManagedId<? super X>`	`getId()` Returns the id of the instance.
`X`	`getInstance()` Returns the instance.
`LockModeType`	`getLockMode()` Returns the lock mode of the instance.
`SessionImpl`	`getSession()` Returns the session.
`Status`	`getStatus()` Returns the status.
`EntityTypeImpl<X>`	`getType()` Returns the type.
`void`	`handleAdditions(EntityManagerImpl entityManager)` Handles the entities that have been added.
`void`	`handleOrphans(EntityManagerImpl entityManager)` Handles the entities that have been orphaned.
`int`	`hashCode()`
`boolean`	`hasInitialId()` Returns if the instance has initial id.
`boolean`	`hasSelfUpdate()` Returns if the instance has self update.
`void`	`incrementVersion(ConnectionImpl connection, boolean commit)` Increments the version of the instance.
`boolean`	`isJoinLoaded(String attributeName)` Returns if attribute name `attributeNaöe` has been loaded.
`boolean`	`isLoading()` Returns if the instance is loading.
`boolean`	`isLoadingFromCache()` Returns if the instance is loading from the cache.
`boolean`	`isRefreshing()` Returns if the instance is refreshing.
`void`	`mergeWith(EntityManagerImpl entityManager, X entity, org.apache.commons.lang.mutable.MutableBoolean requiresFlush, IdentityHashMap<Object,Object> processed)` Merges the instance state with the `entity`.
`void`	`processJoinedMappings()` Processes the associations.
`void`	`refresh(EntityManagerImpl entityManager, ConnectionImpl connection, LockModeType lockMode)` Refreshes the instance from the database.
`void`	`reset()` Resets the change status of the instance.
`void`	`setCache(CacheInstance cacheInstance)` Sets the cache instance
`void`	`setChanged(PluralMapping<?,?,?> association)` Marks the plural association as changed.
`void`	`setJoinLoaded(JoinedMapping<?,?,?> mapping)` Sets the association as loaded.
`void`	`setLoading(boolean loading)` Marks the instance as loading.
`void`	`setLoadingFromCache(boolean loadingFromCache)` Marks the instance as loading loading from the cahce.
`void`	`setOptimisticLock()` Sets the optimistic lock on
`void`	`setRefreshing(boolean refreshing)` Marks the instance as refreshing.
`void`	`setStatus(Status status)` Sets the status.
`void`	`sortLists()` Sorts the list associations.
`String`	`toString()`
`boolean`	`tryLoadFromCache(PluralAssociationMapping<?,?,?> mapping)` Tries to load the collection from the cache.
`void`	`updateCollectionCache(PluralMapping<?,?,?> mapping)` Updates the collection cache of the managed instance for the mapping

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOCK_CONTEXT
```
public static ThreadLocal<LockModeType> LOCK_CONTEXT
```
    The current lock mode context.
- Constructor Detail
  - ManagedInstance
```
public ManagedInstance(EntityTypeImpl<X> type,
               SessionImpl session,
               X instance)
```
    Parameters:
    type - the entity type of the instance
    session - the session
    instance - the instance
    Since:
    
    $version
  - ManagedInstance
```
public ManagedInstance(EntityTypeImpl<X> type,
               SessionImpl session,
               X instance,
               ManagedId<? super X> id)
```
    Parameters:
    type - the entity type of the instance
    session - the session
    instance - the instance
    id - the id of the instance
    Since:
    
    $version
- Method Detail
  - cascadeDetach
```
public void cascadeDetach(EntityManagerImpl entityManager)
```
    Cascades the detach operation.
    
    Parameters:
    entityManager - the entity manager
    Since:
    
    $version
  - cascadePersist
```
public boolean cascadePersist(EntityManagerImpl entityManager,
                     ArrayList<Object> processed)
```
    Cascades the persist operation.
    
    Parameters:
    entityManager - the entity manager
    processed - registry of processed entities
    
    Returns:
    true if an implicit flush is required, false otherwise
    Since:
    
    $version
  - cascadeRemove
```
public void cascadeRemove(EntityManagerImpl entityManager)
```
    Cascades the remove operation
    
    Parameters:
    entityManager - the entity manager
    Since:
    
    $version
  - changed
```
public void changed()
```
    Marks the instance as may have changed.
    
    Since:
    
    $version
  - checkTransients
```
public void checkTransients()
```
    Checks that no association of the instance is transient
    
    Since:
    
    $version
  - checkUpdated
```
public void checkUpdated()
```
    Checks if the instance updated.
    Only meaningful for external entities as their instances' are not enhanced.
    
    Since:
    
    $version
  - checkVersion
```
public void checkVersion(ConnectionImpl connection)
                  throws SQLException
```
    Checks the optimistic lock for the instance.
    
    Parameters:
    connection - the connection
    
    Throws:
    
    SQLException - thrown in case of an SQL error
    Since:
    
    $version
  - enhanceCollections
```
public void enhanceCollections()
```
    Enhances the collections of the managed instance.
    
    Since:
    
    $version
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - fillIdValues
```
public boolean fillIdValues()
```
    Fills the sequence / table generated values. The operation returns false if at least one entity needs to obtain identity from the database.
    
    Returns:
    false if all OK, true if if at least one entity needs to obtain identity from the database
    Since:
    
    $version
  - fireCallbacks
```
public void fireCallbacks(EntityListenerMetadata.EntityListenerType type)
```
    Fires the callbacks.
    
    Parameters:
    type - the type of the callbacks
    Since:
    
    $version
  - flush
```
public void flush(ConnectionImpl connection)
           throws SQLException
```
    Flushes the state of the instance to the database.
    
    Parameters:
    connection - the connection to use to flush
    
    Throws:
    
    SQLException - thrown in case of an SQL error
    Since:
    
    $version
  - flushAssociations
```
public void flushAssociations(ConnectionImpl connection,
                     boolean removals,
                     boolean force)
                       throws SQLException
```
    Flushes the associations.
    
    Parameters:
    connection - the connection
    removals - true if the removals should be flushed and false for the additions
    force - true to force, effective only for insertions and for new entities.
    
    Throws:
    
    SQLException - thrown if there is an underlying SQL Exception
    Since:
    
    $version
  - getAssociationsLoaded
```
public HashSet<JoinedMapping<?,?,?>> getAssociationsLoaded()
```
    Returns the associations that are loaded.
    
    Returns:
    the associations that are loaded.
    Since:
    
    $version
  - getId
```
public ManagedId<? super X> getId()
```
    Returns the id of the instance.
    
    Returns:
    the id of the instance
    Since:
    
    $version
  - getInstance
```
public X getInstance()
```
    Returns the instance.
    
    Returns:
    the instance
    Since:
    
    $version
  - getLockMode
```
public LockModeType getLockMode()
```
    Returns the lock mode of the instance.
    
    Returns:
    the lock mode
    Since:
    
    $version
  - getSession
```
public SessionImpl getSession()
```
    Returns the session.
    
    Returns:
    the session
    Since:
    
    $version
  - getStatus
```
public Status getStatus()
```
    Returns the status.
    
    Returns:
    the status
    Since:
    
    $version
  - getType
```
public EntityTypeImpl<X> getType()
```
    Returns the type.
    
    Returns:
    the type
    Since:
    
    $version
  - handleAdditions
```
public void handleAdditions(EntityManagerImpl entityManager)
```
    Handles the entities that have been added.
    
    Parameters:
    entityManager - the entity manager
    Since:
    
    $version
  - handleOrphans
```
public void handleOrphans(EntityManagerImpl entityManager)
```
    Handles the entities that have been orphaned.
    
    Parameters:
    entityManager - the entity manager
    Since:
    
    $version
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - hasInitialId
```
public boolean hasInitialId()
```
    Returns if the instance has initial id.
    
    Returns:
    true if the instance has initial id, false otherwise
    Since:
    
    $version
  - hasSelfUpdate
```
public boolean hasSelfUpdate()
```
    Returns if the instance has self update.
    
    Returns:
    true if the instance has self update, false otherwise
    Since:
    
    $version
  - incrementVersion
```
public void incrementVersion(ConnectionImpl connection,
                    boolean commit)
                      throws SQLException
```
    Increments the version of the instance.
    
    Parameters:
    connection - the connection
    commit - true if version update should be committed immediately
    
    Throws:
    
    SQLException - thrown in case of an underlying SQL error
    Since:
    
    $version
  - isJoinLoaded
```
public boolean isJoinLoaded(String attributeName)
```
    Returns if attribute name attributeNaöe has been loaded.
    
    Parameters:
    attributeName - the name of the attribute
    
    Returns:
    true if join is loaded, false otherwise
    Since:
    
    $version
  - isLoading
```
public boolean isLoading()
```
    Returns if the instance is loading.
    
    Returns:
    true if the instance is loading, false otherwise
    Since:
    
    $version
  - isLoadingFromCache
```
public boolean isLoadingFromCache()
```
    Returns if the instance is loading from the cache.
    
    Returns:
    true if the instance is loading from the cache, false otherwise
    Since:
    
    $version
  - isRefreshing
```
public boolean isRefreshing()
```
    Returns if the instance is refreshing.
    
    Returns:
    true if the instance is refreshing, false otherwise
    Since:
    
    $version
  - mergeWith
```
public void mergeWith(EntityManagerImpl entityManager,
             X entity,
             org.apache.commons.lang.mutable.MutableBoolean requiresFlush,
             IdentityHashMap<Object,Object> processed)
```
    Merges the instance state with the entity.
    
    Parameters:
    entityManager - the entity manager
    entity - the entity to merge
    requiresFlush - if an implicit flush is required
    processed - registry of processed entities
    Since:
    
    $version
  - processJoinedMappings
```
public void processJoinedMappings()
```
    Processes the associations.
    
    Since:
    
    $version
  - refresh
```
public void refresh(EntityManagerImpl entityManager,
           ConnectionImpl connection,
           LockModeType lockMode)
```
    Refreshes the instance from the database.
    
    Parameters:
    entityManager - the entity manager
    connection - the connection
    lockMode - the lock mode
    Since:
    
    $version
  - reset
```
public void reset()
```
    Resets the change status of the instance.
    
    Since:
    
    $version
  - setCache
```
public void setCache(CacheInstance cacheInstance)
```
    Sets the cache instance
    
    Parameters:
    cacheInstance - the cache instance
    Since:
    
    $version
  - setChanged
```
public void setChanged(PluralMapping<?,?,?> association)
```
    Marks the plural association as changed.
    
    Parameters:
    association - the association that has changed
    Since:
    
    $version
  - setJoinLoaded
```
public void setJoinLoaded(JoinedMapping<?,?,?> mapping)
```
    Sets the association as loaded.
    
    Parameters:
    mapping - the association
    Since:
    
    $version
  - setLoading
```
public void setLoading(boolean loading)
```
    Marks the instance as loading.
    
    Parameters:
    loading - loading to set
    Since:
    
    $version
  - setLoadingFromCache
```
public void setLoadingFromCache(boolean loadingFromCache)
```
    Marks the instance as loading loading from the cahce.
    
    Parameters:
    loadingFromCache - loading to set
    Since:
    
    $version
  - setOptimisticLock
```
public void setOptimisticLock()
```
    Sets the optimistic lock on
    
    Since:
    
    $version
  - setRefreshing
```
public void setRefreshing(boolean refreshing)
```
    Marks the instance as refreshing.
    
    Parameters:
    refreshing - refreshing to set
    Since:
    
    $version
  - setStatus
```
public void setStatus(Status status)
```
    Sets the status.
    
    Parameters:
    status - the status to set
    Since:
    
    $version
  - sortLists
```
public void sortLists()
```
    Sorts the list associations.
    
    Since:
    
    $version
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - tryLoadFromCache
```
public boolean tryLoadFromCache(PluralAssociationMapping<?,?,?> mapping)
```
    Tries to load the collection from the cache.
    
    Parameters:
    mapping - the mapping of the collection
    
    Returns:
    true if the collection was found in the cache, false otherwise
    Since:
    
    $version
  - updateCollectionCache
```
public void updateCollectionCache(PluralMapping<?,?,?> mapping)
```
    Updates the collection cache of the managed instance for the mapping
    
    Parameters:
    mapping - the mapping to update
    Since:
    
    $version

Class ManagedInstance<X>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOCK_CONTEXT

Constructor Detail

ManagedInstance

ManagedInstance

Method Detail

cascadeDetach

cascadePersist

cascadeRemove

changed

checkTransients

checkUpdated

checkVersion

enhanceCollections

equals

fillIdValues

fireCallbacks

flush

flushAssociations

getAssociationsLoaded

getId

getInstance

getLockMode

getSession

getStatus

getType

handleAdditions

handleOrphans

hashCode

hasInitialId

hasSelfUpdate

incrementVersion

isJoinLoaded

isLoading

isLoadingFromCache

isRefreshing

mergeWith

processJoinedMappings

refresh

reset

setCache

setChanged

setJoinLoaded

setLoading

setLoadingFromCache

setOptimisticLock

setRefreshing

setStatus

sortLists

toString

tryLoadFromCache

updateCollectionCache