| org.hibernate.persister.entity.EntityPersister
| Method Summary | |
| public void | afterInitialize(Object entity, boolean lazyPropertiesAreUnfetched, SessionImplementor session)
| | public void | afterReassociate(Object entity, SessionImplementor session)
| | public boolean | canExtractIdOutOfEntity()
Determine whether detahced instances of this entity carry their own
identifier value. | | public Object | createProxy(Serializable id, SessionImplementor session)
| | public void | delete(Serializable id, Object version, Object object, SessionImplementor session)
| | public int[] | findDirty(Object[] currentState, Object[] previousState, Object owner, SessionImplementor session)
Compare the two snapshots to determine if they represent dirty state. | | public int[] | findModified(Object[] old, Object[] current, Object object, SessionImplementor session)
Compare the two snapshots to determine if they represent modified state. | | public Object | forceVersionIncrement(Serializable id, Object currentVersion, SessionImplementor session)
| | public CacheConcurrencyStrategy | getCache()
| | public CacheEntryStructure | getCacheEntryStructure()
| | public ClassMetadata | getClassMetadata()
| | public Class | getConcreteProxyClass(EntityMode entityMode)
Get the proxy interface that instances of this concrete class will be
cast to (optional operation). | | public Object | getCurrentVersion(Serializable id, SessionImplementor session)
Get the current version of the object, or return null if there is no row for
the given identifier. | | public Object[] | getDatabaseSnapshot(Serializable id, SessionImplementor session)
| | public EntityMetamodel | getEntityMetamodel()
Retrieve the underlying entity metamodel instance... | | public String | getEntityName()
The entity name which this persister maps. | | public SessionFactoryImplementor | getFactory()
Return the SessionFactory to which this persister "belongs". | | public Serializable | getIdentifier(Object object, EntityMode entityMode)
| | public IdentifierGenerator | getIdentifierGenerator()
Determine which identifier generation strategy is used for this entity. | | public String | getIdentifierPropertyName()
| | public Type | getIdentifierType()
| | public Class | getMappedClass(EntityMode entityMode)
| | public int[] | getNaturalIdentifierProperties()
If the entity defines a natural id (
EntityPersister.hasNaturalIdentifier() ), which
properties make up the natural id. | | public Object[] | getNaturalIdentifierSnapshot(Serializable id, SessionImplementor session)
Retrieve the current state of the natural-id properties from the database.
Parameters:
id - The identifier of the entity for which to retrieve the naturak-id values.
Parameters:
session - The session from which the request originated. | | public CascadeStyle[] | getPropertyCascadeStyles()
| | public boolean[] | getPropertyCheckability()
| | public ValueInclusion[] | getPropertyInsertGenerationInclusions()
| | public boolean[] | getPropertyInsertability()
| | public boolean[] | getPropertyLaziness()
| | public String[] | getPropertyNames()
| | public boolean[] | getPropertyNullability()
| | public Serializable[] | getPropertySpaces()
Returns an array of objects that identify spaces in which properties of
this entity are persisted, for instances of this class only. | | public Type | getPropertyType(String propertyName)
Get the type of a particular property by name.
Parameters:
propertyName - The name of the property for which to retrievethe typpe. | | public Type[] | getPropertyTypes()
| | public ValueInclusion[] | getPropertyUpdateGenerationInclusions()
| | public boolean[] | getPropertyUpdateability()
| | public Object | getPropertyValue(Object object, int i, EntityMode entityMode)
| | public Object | getPropertyValue(Object object, String propertyName, EntityMode entityMode)
| | public Object[] | getPropertyValues(Object object, EntityMode entityMode)
| | public Object[] | getPropertyValuesToInsert(Object object, Map mergeMap, SessionImplementor session)
| | public boolean[] | getPropertyVersionability()
| | public Serializable[] | getQuerySpaces()
Returns an array of objects that identify spaces in which properties of
this entity are persisted, for instances of this class and its subclasses. | | public String | getRootEntityName()
Returns an object that identifies the space in which identifiers of
this entity hierarchy are unique. | | public EntityPersister | getSubclassEntityPersister(Object instance, SessionFactoryImplementor factory, EntityMode entityMode)
| | public Object | getVersion(Object object, EntityMode entityMode)
| | public int | getVersionProperty()
If
EntityPersister.isVersioned() , then what is the index of the property
holding the locking value. | | public VersionType | getVersionType()
If
EntityPersister.isVersioned() , then what is the type of the property
holding the locking value. | | public EntityMode | guessEntityMode(Object object)
| | public boolean | hasCache()
Does this class have a cache. | | public boolean | hasCascades()
Determine whether this entity has any non-none cascading. | | public boolean | hasCollections()
Determine whether this entity contains references to persistent collections. | | public boolean | hasIdentifierProperty()
Determine whether the entity has a particular property holding
the identifier value. | | public boolean | hasInsertGeneratedProperties()
| | public boolean | hasLazyProperties()
Determine whether this entity defines any lazy properties (ala
bytecode instrumentation). | | public boolean | hasMutableProperties()
Determine whether any properties of this entity are considered mutable. | | public boolean | hasNaturalIdentifier()
Determine whether this entity defines a natural identifier. | | public boolean | hasProxy()
Determine whether this entity supports dynamic proxies. | | public boolean | hasSubselectLoadableCollections()
| | public boolean | hasUninitializedLazyProperties(Object object, EntityMode entityMode)
| | public boolean | hasUpdateGeneratedProperties()
| | public boolean | implementsLifecycle(EntityMode entityMode)
Does the class implement the Lifecycle interface. | | public boolean | implementsValidatable(EntityMode entityMode)
Does the class implement the Validatable interface. | | public void | insert(Serializable id, Object[] fields, Object object, SessionImplementor session)
| | public Serializable | insert(Object[] fields, Object object, SessionImplementor session)
| | public Object | instantiate(Serializable id, EntityMode entityMode)
| | public boolean | isBatchLoadable()
| | public boolean | isCacheInvalidationRequired()
| | public boolean | isIdentifierAssignedByInsert()
Are identifiers of this entity assigned known before the insert execution?
Or, are they generated (in the database) by the insert execution. | | public boolean | isInherited()
Determine whether the entity is inherited one or more other entities. | | public boolean | isInstance(Object object, EntityMode entityMode)
| | public boolean | isInstrumented(EntityMode entityMode)
| | public boolean | isLazyPropertiesCacheable()
| | public boolean | isMutable()
Determine whether instances of this entity are considered mutable. | | public boolean | isSelectBeforeUpdateRequired()
| | public boolean | isSubclassEntityName(String entityName)
Determine whether the given name represents a subclass entity
(or this entity itself) of the entity mapped by this persister.
Parameters:
entityName - The entity name to be checked. | | public Boolean | isTransient(Object object, SessionImplementor session)
| | public boolean | isVersionPropertyGenerated()
| | public boolean | isVersioned()
Determine whether optimistic locking by column is enabled for this
entity. | | public Object | load(Serializable id, Object optionalObject, LockMode lockMode, SessionImplementor session)
Load an instance of the persistent class. | | public void | lock(Serializable id, Object version, Object object, LockMode lockMode, SessionImplementor session)
| | public void | postInstantiate()
Finish the initialization of this object. | | public void | processInsertGeneratedProperties(Serializable id, Object entity, Object[] state, SessionImplementor session)
Perform a select to retrieve the values of any generated properties
back from the database, injecting these generated values into the
given entity as well as writing this state to the
org.hibernate.engine.PersistenceContext . | | public void | processUpdateGeneratedProperties(Serializable id, Object entity, Object[] state, SessionImplementor session)
Perform a select to retrieve the values of any generated properties
back from the database, injecting these generated values into the
given entity as well as writing this state to the
org.hibernate.engine.PersistenceContext . | | public void | resetIdentifier(Object entity, Serializable currentId, Object currentVersion, EntityMode entityMode)
| | public void | setIdentifier(Object object, Serializable id, EntityMode entityMode)
| | public void | setPropertyValue(Object object, int i, Object value, EntityMode entityMode)
| | public void | setPropertyValues(Object object, Object[] values, EntityMode entityMode)
| | public void | update(Serializable id, Object[] fields, int[] dirtyFields, boolean hasDirtyCollection, Object[] oldFields, Object oldVersion, Object object, Object rowId, SessionImplementor session)
|
| ENTITY_ID | | final public static String ENTITY_ID(Code) | | The property name of the "special" identifier property in HQL
|
| afterInitialize | | public void afterInitialize(Object entity, boolean lazyPropertiesAreUnfetched, SessionImplementor session)(Code) | | Called just after the entities properties have been initialized
|
| afterReassociate | | public void afterReassociate(Object entity, SessionImplementor session)(Code) | | Called just after the entity has been reassociated with the session
|
| canExtractIdOutOfEntity | | public boolean canExtractIdOutOfEntity()(Code) | | Determine whether detahced instances of this entity carry their own
identifier value.
The other option is the deperecated feature where users could supply
the id during session calls.
True if either (1) EntityPersister.hasIdentifierProperty() or(2) the identifier is an embedded composite identifier; false otherwise. |
| findDirty | | public int[] findDirty(Object[] currentState, Object[] previousState, Object owner, SessionImplementor session)(Code) | | Compare the two snapshots to determine if they represent dirty state.
Parameters:
currentState - The current snapshot
Parameters:
previousState - The baseline snapshot
Parameters:
owner - The entity containing the state
Parameters:
session - The originating session The indices of all dirty properties, or null if no propertieswere dirty. |
| findModified | | public int[] findModified(Object[] old, Object[] current, Object object, SessionImplementor session)(Code) | | Compare the two snapshots to determine if they represent modified state.
Parameters:
old - The baseline snapshot
Parameters:
current - The current snapshot
Parameters:
object - The entity containing the state
Parameters:
session - The originating session The indices of all modified properties, or null if no propertieswere modified. |
| getClassMetadata | | public ClassMetadata getClassMetadata()(Code) | | Get the user-visible metadata for the class (optional operation)
|
| getConcreteProxyClass | | public Class getConcreteProxyClass(EntityMode entityMode)(Code) | | Get the proxy interface that instances of this concrete class will be
cast to (optional operation).
|
| getEntityMetamodel | | public EntityMetamodel getEntityMetamodel()(Code) | | Retrieve the underlying entity metamodel instance...
The metamodel |
| getEntityName | | public String getEntityName()(Code) | | The entity name which this persister maps.
The name of the entity which this persister maps. |
| getIdentifierGenerator | | public IdentifierGenerator getIdentifierGenerator()(Code) | | Determine which identifier generation strategy is used for this entity.
The identifier generation strategy. |
| getIdentifierPropertyName | | public String getIdentifierPropertyName()(Code) | | Get the name of the identifier property (or return null) - need not return the
name of an actual Java property
|
| getIdentifierType | | public Type getIdentifierType()(Code) | | Get the identifier type
|
| getNaturalIdentifierProperties | | public int[] getNaturalIdentifierProperties()(Code) | | If the entity defines a natural id (
EntityPersister.hasNaturalIdentifier() ), which
properties make up the natural id.
The indices of the properties making of the natural id; ornull, if no natural id is defined. |
| getNaturalIdentifierSnapshot | | public Object[] getNaturalIdentifierSnapshot(Serializable id, SessionImplementor session)(Code) | | Retrieve the current state of the natural-id properties from the database.
Parameters:
id - The identifier of the entity for which to retrieve the naturak-id values.
Parameters:
session - The session from which the request originated. The natural-id snapshot. |
| getPropertyCascadeStyles | | public CascadeStyle[] getPropertyCascadeStyles()(Code) | | Get the cascade styles of the propertes (optional operation)
|
| getPropertyCheckability | | public boolean[] getPropertyCheckability()(Code) | | Get the "checkability" of the properties of this class
(is the property dirty checked, does the cache need
to be updated)
|
| getPropertyInsertGenerationInclusions | | public ValueInclusion[] getPropertyInsertGenerationInclusions()(Code) | | Which of the properties of this class are database generated values on insert?
|
| getPropertyInsertability | | public boolean[] getPropertyInsertability()(Code) | | Get the "insertability" of the properties of this class
(does the property appear in an SQL INSERT)
|
| getPropertyLaziness | | public boolean[] getPropertyLaziness()(Code) | | |
| getPropertyNames | | public String[] getPropertyNames()(Code) | | Get the names of the class properties - doesn't have to be the names of the
actual Java properties (used for XML generation only)
|
| getPropertyNullability | | public boolean[] getPropertyNullability()(Code) | | Get the nullability of the properties of this class
|
| getPropertySpaces | | public Serializable[] getPropertySpaces()(Code) | | Returns an array of objects that identify spaces in which properties of
this entity are persisted, for instances of this class only.
For most implementations, this returns the complete set of table names
to which instances of the mapped entity are persisted (not accounting
for superclass entity mappings).
The property spaces. |
| getPropertyType | | public Type getPropertyType(String propertyName) throws MappingException(Code) | | Get the type of a particular property by name.
Parameters:
propertyName - The name of the property for which to retrievethe typpe. The type.
throws:
org.hibernate.MappingException - Typically indicates an unknownproperty name. |
| getPropertyTypes | | public Type[] getPropertyTypes()(Code) | | Get the Hibernate types of the class properties
|
| getPropertyUpdateGenerationInclusions | | public ValueInclusion[] getPropertyUpdateGenerationInclusions()(Code) | | Which of the properties of this class are database generated values on update?
|
| getPropertyUpdateability | | public boolean[] getPropertyUpdateability()(Code) | | Get the "updateability" of the properties of this class
(does the property appear in an SQL UPDATE)
|
| getPropertyVersionability | | public boolean[] getPropertyVersionability()(Code) | | Get the "versionability" of the properties of this class
(is the property optimistic-locked)
|
| getQuerySpaces | | public Serializable[] getQuerySpaces()(Code) | | Returns an array of objects that identify spaces in which properties of
this entity are persisted, for instances of this class and its subclasses.
Much like
EntityPersister.getPropertySpaces() , except that here we include subclass
entity spaces.
The query spaces. |
| getRootEntityName | | public String getRootEntityName()(Code) | | Returns an object that identifies the space in which identifiers of
this entity hierarchy are unique. Might be a table name, a JNDI URL, etc.
The root entity name. |
| getVersionProperty | | public int getVersionProperty()(Code) | | If
EntityPersister.isVersioned() , then what is the index of the property
holding the locking value.
The type of the version property; or -66, if not versioned. |
| guessEntityMode | | public EntityMode guessEntityMode(Object object)(Code) | | Try to discover the entity mode from the entity instance
|
| hasCache | | public boolean hasCache()(Code) | | Does this class have a cache.
|
| hasCascades | | public boolean hasCascades()(Code) | | Determine whether this entity has any non-none cascading.
True if the entity has any properties with a cscade other than NONE;false otherwise (aka, no cascading). |
| hasCollections | | public boolean hasCollections()(Code) | | Determine whether this entity contains references to persistent collections.
True if the entity does contain persistent collections; false otherwise. |
| hasIdentifierProperty | | public boolean hasIdentifierProperty()(Code) | | Determine whether the entity has a particular property holding
the identifier value.
True if the entity has a specific property holding identifier value. |
| hasInsertGeneratedProperties | | public boolean hasInsertGeneratedProperties()(Code) | | Does this entity define any properties as being database generated on insert?
True if this entity contains at least one property definedas generated (including version property, but not identifier). |
| hasLazyProperties | | public boolean hasLazyProperties()(Code) | | Determine whether this entity defines any lazy properties (ala
bytecode instrumentation).
True if the entity has properties mapped as lazy; false otherwise. |
| hasMutableProperties | | public boolean hasMutableProperties()(Code) | | Determine whether any properties of this entity are considered mutable.
True if any properties of the entity are mutable; false otherwise (meaning none are). |
| hasNaturalIdentifier | | public boolean hasNaturalIdentifier()(Code) | | Determine whether this entity defines a natural identifier.
True if the entity defines a natural id; false otherwise. |
| hasProxy | | public boolean hasProxy()(Code) | | Determine whether this entity supports dynamic proxies.
True if the entity has dynamic proxy support; false otherwise. |
| hasSubselectLoadableCollections | | public boolean hasSubselectLoadableCollections()(Code) | | Determine whether this entity contains references to persistent collections
which are fetchable by subselect?
True if the entity contains collections fetchable by subselect; false otherwise. |
| hasUninitializedLazyProperties | | public boolean hasUninitializedLazyProperties(Object object, EntityMode entityMode)(Code) | | Does the given instance have any uninitialized lazy properties?
|
| hasUpdateGeneratedProperties | | public boolean hasUpdateGeneratedProperties()(Code) | | Does this entity define any properties as being database generated on update?
True if this entity contains at least one property definedas generated (including version property, but not identifier). |
| implementsLifecycle | | public boolean implementsLifecycle(EntityMode entityMode)(Code) | | Does the class implement the Lifecycle interface.
|
| implementsValidatable | | public boolean implementsValidatable(EntityMode entityMode)(Code) | | Does the class implement the Validatable interface.
|
| isBatchLoadable | | public boolean isBatchLoadable()(Code) | | Is batch loading enabled?
|
| isCacheInvalidationRequired | | public boolean isCacheInvalidationRequired()(Code) | | Should we always invalidate the cache instead of
recaching updated state
|
| isIdentifierAssignedByInsert | | public boolean isIdentifierAssignedByInsert()(Code) | | Are identifiers of this entity assigned known before the insert execution?
Or, are they generated (in the database) by the insert execution.
True if identifiers for this entity are generated by the insertexecution. |
| isInherited | | public boolean isInherited()(Code) | | Determine whether the entity is inherited one or more other entities.
In other words, is this entity a subclass of other entities.
True if other entities extend this entity; false otherwise. |
| isInstance | | public boolean isInstance(Object object, EntityMode entityMode)(Code) | | Is the given object an instance of this entity?
|
| isInstrumented | | public boolean isInstrumented(EntityMode entityMode)(Code) | | Has the class actually been bytecode instrumented?
|
| isLazyPropertiesCacheable | | public boolean isLazyPropertiesCacheable()(Code) | | Should lazy properties of this entity be cached?
|
| isMutable | | public boolean isMutable()(Code) | | Determine whether instances of this entity are considered mutable.
True if the entity is considered mutable; false otherwise. |
| isSelectBeforeUpdateRequired | | public boolean isSelectBeforeUpdateRequired()(Code) | | Is select snapshot before update enabled?
|
| isSubclassEntityName | | public boolean isSubclassEntityName(String entityName)(Code) | | Determine whether the given name represents a subclass entity
(or this entity itself) of the entity mapped by this persister.
Parameters:
entityName - The entity name to be checked. True if the given entity name represents either the entitymapped by this persister or one of its subclass entities; falseotherwise. |
| isVersionPropertyGenerated | | public boolean isVersionPropertyGenerated()(Code) | | Does this entity contain a version property that is defined
to be database generated?
true if this entity contains a version property and thatproperty has been marked as generated. |
| isVersioned | | public boolean isVersioned()(Code) | | Determine whether optimistic locking by column is enabled for this
entity.
True if optimistic locking by column (i.e., or) is enabled; false otherwise. |
| processInsertGeneratedProperties | | public void processInsertGeneratedProperties(Serializable id, Object entity, Object[] state, SessionImplementor session)(Code) | | Perform a select to retrieve the values of any generated properties
back from the database, injecting these generated values into the
given entity as well as writing this state to the
org.hibernate.engine.PersistenceContext .
Note, that because we update the PersistenceContext here, callers
need to take care that they have already written the initial snapshot
to the PersistenceContext before calling this method.
Parameters:
id - The entity's id value.
Parameters:
entity - The entity for which to get the state.
Parameters:
state -
Parameters:
session - The session |
| processUpdateGeneratedProperties | | public void processUpdateGeneratedProperties(Serializable id, Object entity, Object[] state, SessionImplementor session)(Code) | | Perform a select to retrieve the values of any generated properties
back from the database, injecting these generated values into the
given entity as well as writing this state to the
org.hibernate.engine.PersistenceContext .
Note, that because we update the PersistenceContext here, callers
need to take care that they have already written the initial snapshot
to the PersistenceContext before calling this method.
Parameters:
id - The entity's id value.
Parameters:
entity - The entity for which to get the state.
Parameters:
state -
Parameters:
session - The session |
| resetIdentifier | | public void resetIdentifier(Object entity, Serializable currentId, Object currentVersion, EntityMode entityMode)(Code) | | Set the identifier and version of the given instance back
to its "unsaved" value, returning the id
Parameters:
currentId - TODO
Parameters:
currentVersion - TODO |
|
|