public interface LazyInitializer
Handles fetching of the underlying entity for a proxy
Modifier and Type | Method and Description |
---|---|
String |
getEntityName()
The entity-name of the entity our owning proxy represents.
|
Serializable |
getIdentifier()
Retrieve the identifier value for the entity our owning proxy represents.
|
Object |
getImplementation()
Return the underlying persistent object, initializing if necessary
|
Object |
getImplementation(SharedSessionContractImplementor session)
Return the underlying persistent object in the given session, or null if not contained in this session’s
persistence context.
|
Class |
getPersistentClass()
Get the actual class of the entity.
|
SharedSessionContractImplementor |
getSession()
Get the session to which this proxy is associated, or null if it is not attached.
|
void |
initialize()
Initialize the proxy, fetching the target entity if necessary.
|
boolean |
isReadOnly()
Is the proxy read-only?.
|
boolean |
isReadOnlySettingAvailable()
Is the proxy’s read-only/modifiable setting available?
|
boolean |
isUninitialized()
Is the proxy uninitialzed?
|
boolean |
isUnwrap() |
void |
setIdentifier(Serializable id)
Set the identifier value for the entity our owning proxy represents.
|
void |
setImplementation(Object target)
Initialize the proxy manually by injecting its target.
|
void |
setReadOnly(boolean readOnly)
Set an associated modifiable proxy to read-only mode, or a read-only
proxy to modifiable mode.
|
void |
setSession(SharedSessionContractImplementor session)
Associate the proxy with the given session.
|
void |
setUnwrap(boolean unwrap) |
void |
unsetSession()
Unset this initializer’s reference to session.
|
void initialize() throws HibernateException
Initialize the proxy, fetching the target entity if necessary.
HibernateException
- Indicates a problem initializing the proxy.Serializable getIdentifier()
Retrieve the identifier value for the entity our owning proxy represents.
void setIdentifier(Serializable id)
Set the identifier value for the entity our owning proxy represents.
id
- The identifier value.String getEntityName()
The entity-name of the entity our owning proxy represents.
Class getPersistentClass()
Get the actual class of the entity. Generally, getEntityName()
should be used instead.
boolean isUninitialized()
Is the proxy uninitialzed?
Object getImplementation()
Return the underlying persistent object, initializing if necessary
Object getImplementation(SharedSessionContractImplementor session) throws HibernateException
Return the underlying persistent object in the given session, or null if not contained in this session’s persistence context.
session
- The session to checkHibernateException
- Indicates problem locating the target.void setImplementation(Object target)
Initialize the proxy manually by injecting its target.
target
- The proxy target (the actual entity being proxied).boolean isReadOnlySettingAvailable()
Is the proxy’s read-only/modifiable setting available?
boolean isReadOnly()
Is the proxy read-only?.
The read-only/modifiable setting is not available when the proxy is detached or its associated session is closed.
To check if the read-only/modifiable setting is available:
TransientObjectException
- if the proxy is detached (getSession() == null)SessionException
- if the proxy is associated with a sesssion that is closedisReadOnlySettingAvailable()
,
Session.isReadOnly(Object entityOrProxy)
void setReadOnly(boolean readOnly)
Set an associated modifiable proxy to read-only mode, or a read-only proxy to modifiable mode. If the proxy is currently initialized, its implementation will be set to the same mode; otherwise, when the proxy is initialized, its implementation will have the same read-only/ modifiable setting as the proxy. In read-only mode, no snapshot is maintained and the instance is never dirty checked.
If the associated proxy already has the specified read-only/modifiable setting, then this method does nothing.
readOnly
- if true, the associated proxy is made read-only;
if false, the associated proxy is made modifiable.TransientObjectException
- if the proxy is not association with a sessionSessionException
- if the proxy is associated with a session that is closedSession.setReadOnly(Object entityOrProxy, boolean readOnly)
SharedSessionContractImplementor getSession()
Get the session to which this proxy is associated, or null if it is not attached.
void setSession(SharedSessionContractImplementor session) throws HibernateException
Associate the proxy with the given session. <p/> Care should be given to make certain that the proxy is added to the session’s persistence context as well to maintain the symetry of the association. That must be done seperately as this method simply sets an internal reference. We do also check that if there is already an associated session that the proxy reference was removed from that previous session’s persistence contet.
session
- The sessionHibernateException
- Indicates that the proxy was still contained in the persistence context of the
"previous session".void unsetSession()
Unset this initializer’s reference to session. It is assumed that the caller is also taking care or
cleaning up the owning proxy’s reference in the persistence context.
<p/>
Generally speaking this is intended to be called only during Session.evict(java.lang.Object)
and
Session.clear()
processing; most other use-cases should call setSession(org.hibernate.engine.spi.SharedSessionContractImplementor)
instead.
void setUnwrap(boolean unwrap)
boolean isUnwrap()
Copyright © 2001-2018 Red Hat, Inc. All Rights Reserved.