Package org.hibernate.jpa.internal

Class JpaComplianceImpl

java.lang.Object

org.hibernate.jpa.internal.JpaComplianceImpl

All Implemented Interfaces:

JpaCompliance

public class JpaComplianceImpl
extends Object
implements JpaCompliance

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JpaComplianceImpl.JpaComplianceBuilder

Constructor Summary

Constructors

Constructor	Description
JpaComplianceImpl(boolean listCompliance, boolean orderByMappingCompliance, boolean proxyCompliance, boolean globalGeneratorNameScopeCompliance, boolean queryCompliance, boolean transactionCompliance, boolean closedCompliance, boolean cachingCompliance, boolean loadByIdCompliance, boolean cascadeCompliance)

Method Summary

Modifier and Type	Method	Description
boolean	isGlobalGeneratorScopeEnabled()	Should the scope of TableGenerator.name() and SequenceGenerator.name() be considered globally or locally defined?
boolean	isJpaCacheComplianceEnabled()	Should Hibernate comply with all aspects of caching as defined by JPA? Or can it deviate to perform things it believes will be "better"?
boolean	isJpaCascadeComplianceEnabled()	JPA specifies that a CascadeType.PERSIST operation should occur at flush time.
boolean	isJpaClosedComplianceEnabled()	JPA defines specific exceptions on specific methods when called on EntityManager and EntityManagerFactory when those objects have been closed.
boolean	isJpaListComplianceEnabled()	Controls how Hibernate interprets a mapped List without no order column specified.
boolean	isJpaOrderByMappingComplianceEnabled()	Should we strictly handle OrderBy expressions?
boolean	isJpaProxyComplianceEnabled()	JPA spec says that an EntityNotFoundException should be thrown when accessing an entity proxy which does not have an associated table row in the database.
boolean	isJpaQueryComplianceEnabled()	Controls whether Hibernate's handling of JPA's Query (JPQL, Criteria and native-query) should strictly follow the JPA spec.
boolean	isJpaTransactionComplianceEnabled()	Indicates that Hibernate's Transaction should behave as defined by the specification for JPA's EntityTransaction since it extends it.
boolean	isLoadByIdComplianceEnabled()	JPA says that the id passed to EntityManager.getReference(java.lang.Class<T>, java.lang.Object) and EntityManager.find(java.lang.Class<T>, java.lang.Object) should be exactly the expected type, allowing no type coercion.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JpaComplianceImpl

public JpaComplianceImpl(boolean listCompliance,
                         boolean orderByMappingCompliance,
                         boolean proxyCompliance,
                         boolean globalGeneratorNameScopeCompliance,
                         boolean queryCompliance,
                         boolean transactionCompliance,
                         boolean closedCompliance,
                         boolean cachingCompliance,
                         boolean loadByIdCompliance,
                         boolean cascadeCompliance)

Method Detail

isJpaQueryComplianceEnabled

public boolean isJpaQueryComplianceEnabled()

Description copied from interface: JpaCompliance

Controls whether Hibernate's handling of JPA's Query (JPQL, Criteria and native-query) should strictly follow the JPA spec. This includes parsing and translating a query as JPQL instead of HQL, as well as whether calls to the Query methods always throw the exceptions defined by the specification.

Deviations result in an exception, if enabled.

Specified by:

isJpaQueryComplianceEnabled in interface JpaCompliance

Returns:

true indicates to behave in the spec-defined way

See Also:

JpaComplianceSettings.JPA_QUERY_COMPLIANCE

isJpaTransactionComplianceEnabled

public boolean isJpaTransactionComplianceEnabled()

Description copied from interface: JpaCompliance

Indicates that Hibernate's Transaction should behave as defined by the specification for JPA's EntityTransaction since it extends it.

Specified by:

isJpaTransactionComplianceEnabled in interface JpaCompliance

Returns:

true indicates to behave in the spec-defined way

See Also:

JpaComplianceSettings.JPA_TRANSACTION_COMPLIANCE

isJpaCascadeComplianceEnabled

public boolean isJpaCascadeComplianceEnabled()

Description copied from interface: JpaCompliance

JPA specifies that a CascadeType.PERSIST operation should occur at flush time. The legacy behavior of Hibernate was a CascadeType.SAVE_UPDATE.

Specified by:

isJpaCascadeComplianceEnabled in interface JpaCompliance

Returns:

true indicates to behave in the spec-defined way

See Also:

JpaComplianceSettings.JPA_CASCADE_COMPLIANCE

isJpaListComplianceEnabled

public boolean isJpaListComplianceEnabled()

Description copied from interface: JpaCompliance

Controls how Hibernate interprets a mapped List without no order column specified. Historically Hibernate treats this as a "bag", which is a concept JPA does not have.

• If enabled, Hibernate will recognize this case as a list.
• Otherwise, if disabled, Hibernate will treat it as a "bag".

Specified by:

isJpaListComplianceEnabled in interface JpaCompliance

Returns:

true indicates to behave in the spec-defined way, interpreting the mapping as a "list", rather than a "bag"

See Also:

JpaComplianceSettings.JPA_LIST_COMPLIANCE

isJpaClosedComplianceEnabled

public boolean isJpaClosedComplianceEnabled()

Description copied from interface: JpaCompliance

JPA defines specific exceptions on specific methods when called on EntityManager and EntityManagerFactory when those objects have been closed. This setting controls whether the spec defined behavior or Hibernate's behavior will be used.

If enabled Hibernate will operate in the JPA specified way throwing exceptions when the spec says it should with regard to close checking

Specified by:

isJpaClosedComplianceEnabled in interface JpaCompliance

Returns:

true indicates to behave in the spec-defined way

See Also:

JpaComplianceSettings.JPA_CLOSED_COMPLIANCE

isJpaProxyComplianceEnabled

public boolean isJpaProxyComplianceEnabled()

Description copied from interface: JpaCompliance

JPA spec says that an EntityNotFoundException should be thrown when accessing an entity proxy which does not have an associated table row in the database.

Traditionally, Hibernate does not initialize an entity Proxy when accessing its identifier since we already know the identifier value, hence we can save a database round trip.

If enabled Hibernate will initialize the entity proxy even when accessing its identifier.

Specified by:

isJpaProxyComplianceEnabled in interface JpaCompliance

Returns:

true indicates to behave in the spec-defined way

See Also:

JpaComplianceSettings.JPA_PROXY_COMPLIANCE

isJpaCacheComplianceEnabled

public boolean isJpaCacheComplianceEnabled()

Description copied from interface: JpaCompliance

Should Hibernate comply with all aspects of caching as defined by JPA? Or can it deviate to perform things it believes will be "better"?

Specified by:

isJpaCacheComplianceEnabled in interface JpaCompliance

Returns:

true indicates to behave in the spec-defined way

See Also:

JpaComplianceSettings.JPA_CACHING_COMPLIANCE, AbstractEntityPersister.isCacheInvalidationRequired()

isGlobalGeneratorScopeEnabled

public boolean isGlobalGeneratorScopeEnabled()

Description copied from interface: JpaCompliance

Should the scope of TableGenerator.name() and SequenceGenerator.name() be considered globally or locally defined?

Specified by:

isGlobalGeneratorScopeEnabled in interface JpaCompliance

Returns:

true if the generator name scope is considered global

See Also:

JpaComplianceSettings.JPA_ID_GENERATOR_GLOBAL_SCOPE_COMPLIANCE

isJpaOrderByMappingComplianceEnabled

public boolean isJpaOrderByMappingComplianceEnabled()

Description copied from interface: JpaCompliance

Should we strictly handle OrderBy expressions?

JPA says the order-items can only be attribute references whereas Hibernate supports a wide range of items. With this enabled, Hibernate will throw a compliance error when a non-attribute-reference is used.

Specified by:

isJpaOrderByMappingComplianceEnabled in interface JpaCompliance

See Also:

JpaComplianceSettings.JPA_ORDER_BY_MAPPING_COMPLIANCE

isLoadByIdComplianceEnabled

public boolean isLoadByIdComplianceEnabled()

Description copied from interface: JpaCompliance

JPA says that the id passed to EntityManager.getReference(java.lang.Class<T>, java.lang.Object) and EntityManager.find(java.lang.Class<T>, java.lang.Object) should be exactly the expected type, allowing no type coercion.

Historically, Hibernate behaved the same way. Since 6.0 however, Hibernate has the ability to coerce the passed type to the expected type. For example, an Integer may be widened to Long. Coercion is performed by calling JavaType.coerce(X, org.hibernate.type.descriptor.java.JavaType.CoercionContext).

This setting controls whether such coercion should be allowed.

Specified by:

isLoadByIdComplianceEnabled in interface JpaCompliance

See Also:

JpaComplianceSettings.JPA_LOAD_BY_ID_COMPLIANCE