org.hibernate.persister.entity.EntityPersister Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-core Show documentation
Show all versions of hibernate-core Show documentation
Hibernate's core ORM functionality
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or .
*/
package org.hibernate.persister.entity;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
import org.hibernate.EntityMode;
import org.hibernate.HibernateException;
import org.hibernate.LockMode;
import org.hibernate.LockOptions;
import org.hibernate.MappingException;
import org.hibernate.bytecode.enhance.spi.interceptor.EnhancementAsProxyLazinessInterceptor;
import org.hibernate.bytecode.spi.BytecodeEnhancementMetadata;
import org.hibernate.bytecode.spi.NotInstrumentedException;
import org.hibernate.cache.spi.access.EntityDataAccess;
import org.hibernate.cache.spi.access.NaturalIdDataAccess;
import org.hibernate.cache.spi.entry.CacheEntry;
import org.hibernate.cache.spi.entry.CacheEntryStructure;
import org.hibernate.engine.spi.CascadeStyle;
import org.hibernate.engine.spi.EntityEntryFactory;
import org.hibernate.engine.spi.SessionFactoryImplementor;
import org.hibernate.engine.spi.SharedSessionContractImplementor;
import org.hibernate.engine.spi.ValueInclusion;
import org.hibernate.id.IdentifierGenerator;
import org.hibernate.internal.FilterAliasGenerator;
import org.hibernate.metadata.ClassMetadata;
import org.hibernate.metamodel.model.domain.NavigableRole;
import org.hibernate.persister.walking.spi.EntityDefinition;
import org.hibernate.tuple.entity.EntityMetamodel;
import org.hibernate.tuple.entity.EntityTuplizer;
import org.hibernate.type.Type;
import org.hibernate.type.VersionType;
/**
* Contract describing mapping information and persistence logic for a particular strategy of entity mapping. A given
* persister instance corresponds to a given mapped entity class.
*
* Implementations must be thread-safe (preferably immutable).
*
* Unless a custom {@link org.hibernate.persister.spi.PersisterFactory} is used, it is expected
* that implementations of EntityPersister define a constructor accepting the following arguments:
* -
* {@link org.hibernate.mapping.PersistentClass} - describes the metadata about the entity
* to be handled by the persister
*
* -
* {@link org.hibernate.cache.spi.access.EntityDataAccess} - the second level caching strategy for this entity
*
* -
* {@link org.hibernate.cache.spi.access.NaturalIdDataAccess} - the second level caching strategy for the natural-id
* defined for this entity, if one
*
* -
* {@link org.hibernate.persister.spi.PersisterCreationContext} - access to additional
* information useful while constructing the persister.
*
*
*
* @author Gavin King
* @author Steve Ebersole
*
* @see org.hibernate.persister.spi.PersisterFactory
* @see org.hibernate.persister.spi.PersisterClassResolver
*/
public interface EntityPersister extends EntityDefinition {
/**
* The property name of the "special" identifier property in HQL
*/
String ENTITY_ID = "id";
/**
* Generate the entity definition for this object. This must be done for all
* entity persisters before calling {@link #postInstantiate()}.
*/
void generateEntityDefinition();
/**
* Finish the initialization of this object. {@link #generateEntityDefinition()}
* must be called for all entity persisters before calling this method.
*
* Called only once per {@link org.hibernate.SessionFactory} lifecycle,
* after all entity persisters have been instantiated.
*
* @throws org.hibernate.MappingException Indicates an issue in the metadata.
*/
void postInstantiate() throws MappingException;
/**
* Return the SessionFactory to which this persister "belongs".
*
* @return The owning SessionFactory.
*/
SessionFactoryImplementor getFactory();
NavigableRole getNavigableRole();
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// stuff that is persister-centric and/or EntityInfo-centric ~~~~~~~~~~~~~~
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* Get the EntityEntryFactory indicated for the entity mapped by this persister.
*
* @return The proper EntityEntryFactory.
*/
EntityEntryFactory getEntityEntryFactory();
/**
* 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.
*
* @return The root entity name.
*/
String getRootEntityName();
/**
* The entity name which this persister maps.
*
* @return The name of the entity which this persister maps.
*/
String getEntityName();
/**
* Retrieve the underlying entity metamodel instance...
*
*@return The metamodel
*/
EntityMetamodel getEntityMetamodel();
/**
* Called from {@link EnhancementAsProxyLazinessInterceptor} to trigger load of
* the entity's non-lazy state as well as the named attribute we are accessing
* if it is still uninitialized after fetching non-lazy state
*/
default Object initializeEnhancedEntityUsedAsProxy(
Object entity,
String nameOfAttributeBeingAccessed,
SharedSessionContractImplementor session) {
throw new UnsupportedOperationException(
"Initialization of entity enhancement used to act like a proxy is not supported by this EntityPersister : " + getClass().getName()
);
}
/**
* Determine whether the given name represents a subclass entity
* (or this entity itself) of the entity mapped by this persister.
*
* @param entityName The entity name to be checked.
* @return True if the given entity name represents either the entity
* mapped by this persister or one of its subclass entities; false
* otherwise.
*/
boolean isSubclassEntityName(String entityName);
/**
* 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).
*
* @return The property spaces.
*/
Serializable[] getPropertySpaces();
/**
* 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 {@link #getPropertySpaces()}, except that here we include subclass
* entity spaces.
*
* @return The query spaces.
*/
Serializable[] getQuerySpaces();
/**
* Determine whether this entity supports dynamic proxies.
*
* @return True if the entity has dynamic proxy support; false otherwise.
*/
boolean hasProxy();
/**
* Determine whether this entity contains references to persistent collections.
*
* @return True if the entity does contain persistent collections; false otherwise.
*/
boolean hasCollections();
/**
* Determine whether any properties of this entity are considered mutable.
*
* @return True if any properties of the entity are mutable; false otherwise (meaning none are).
*/
boolean hasMutableProperties();
/**
* Determine whether this entity contains references to persistent collections
* which are fetchable by subselect?
*
* @return True if the entity contains collections fetchable by subselect; false otherwise.
*/
boolean hasSubselectLoadableCollections();
/**
* Determine whether this entity has any non-none cascading.
*
* @return True if the entity has any properties with a cascade other than NONE;
* false otherwise (aka, no cascading).
*/
boolean hasCascades();
/**
* Determine whether instances of this entity are considered mutable.
*
* @return True if the entity is considered mutable; false otherwise.
*/
boolean isMutable();
/**
* Determine whether the entity is inherited one or more other entities.
* In other words, is this entity a subclass of other entities.
*
* @return True if other entities extend this entity; false otherwise.
*/
boolean isInherited();
/**
* Are identifiers of this entity assigned known before the insert execution?
* Or, are they generated (in the database) by the insert execution.
*
* @return True if identifiers for this entity are generated by the insert
* execution.
*/
boolean isIdentifierAssignedByInsert();
/**
* Get the type of a particular property by name.
*
* @param propertyName The name of the property for which to retrieve
* the type.
* @return The type.
* @throws org.hibernate.MappingException Typically indicates an unknown
* property name.
*/
Type getPropertyType(String propertyName) throws MappingException;
/**
* Compare the two snapshots to determine if they represent dirty state.
*
* @param currentState The current snapshot
* @param previousState The baseline snapshot
* @param owner The entity containing the state
* @param session The originating session
* @return The indices of all dirty properties, or null if no properties
* were dirty.
*/
int[] findDirty(Object[] currentState, Object[] previousState, Object owner, SharedSessionContractImplementor session);
/**
* Compare the two snapshots to determine if they represent modified state.
*
* @param old The baseline snapshot
* @param current The current snapshot
* @param object The entity containing the state
* @param session The originating session
* @return The indices of all modified properties, or null if no properties
* were modified.
*/
int[] findModified(Object[] old, Object[] current, Object object, SharedSessionContractImplementor session);
/**
* Determine whether the entity has a particular property holding
* the identifier value.
*
* @return True if the entity has a specific property holding identifier value.
*/
boolean hasIdentifierProperty();
/**
* Determine whether detached instances of this entity carry their own
* identifier value.
*
* The other option is the deprecated feature where users could supply
* the id during session calls.
*
* @return True if either (1) {@link #hasIdentifierProperty()} or
* (2) the identifier is an embedded composite identifier; false otherwise.
*/
boolean canExtractIdOutOfEntity();
/**
* Determine whether optimistic locking by column is enabled for this
* entity.
*
* @return True if optimistic locking by column (i.e.,