org.hibernate.mapping.Property Maven / Gradle / Ivy
Show all versions of beangle-hibernate-core Show documentation
/*
* 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.mapping;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Map;
import java.util.StringTokenizer;
import org.hibernate.HibernateException;
import org.hibernate.Internal;
import org.hibernate.MappingException;
import org.hibernate.boot.model.relational.Database;
import org.hibernate.bytecode.enhance.spi.interceptor.EnhancementHelper;
import org.hibernate.cfg.AvailableSettings;
import org.hibernate.engine.spi.CascadeStyle;
import org.hibernate.engine.spi.CascadeStyles;
import org.hibernate.engine.spi.Mapping;
import org.hibernate.jpa.event.spi.CallbackDefinition;
import org.hibernate.metamodel.RepresentationMode;
import org.hibernate.metamodel.spi.RuntimeModelCreationContext;
import org.hibernate.property.access.spi.Getter;
import org.hibernate.property.access.spi.PropertyAccessStrategy;
import org.hibernate.property.access.spi.PropertyAccessStrategyResolver;
import org.hibernate.property.access.spi.Setter;
import org.hibernate.service.ServiceRegistry;
import org.hibernate.generator.Generator;
import org.hibernate.generator.GeneratorCreationContext;
import org.hibernate.type.AnyType;
import org.hibernate.type.CollectionType;
import org.hibernate.type.ComponentType;
import org.hibernate.type.CompositeType;
import org.hibernate.type.Type;
import org.hibernate.type.WrapperArrayHandling;
import static java.util.Collections.emptyList;
import static java.util.Collections.unmodifiableList;
/**
* A mapping model object representing a property or field of an {@linkplain PersistentClass entity}
* or {@linkplain Component embeddable class}.
*
* @author Gavin King
*/
public class Property implements Serializable, MetaAttributable {
private String name;
private Value value;
private String cascade;
private boolean updateable = true;
private boolean insertable = true;
private boolean selectable = true;
private boolean optimisticLocked = true;
private GeneratorCreator generatorCreator;
private String propertyAccessorName;
private PropertyAccessStrategy propertyAccessStrategy;
private boolean lazy;
private String lazyGroup;
private boolean optional;
private java.util.Map metaAttributes;
private PersistentClass persistentClass;
private boolean naturalIdentifier;
private boolean isGeneric;
private boolean lob;
private java.util.List callbackDefinitions;
private String returnedClassName;
public boolean isBackRef() {
return false;
}
/**
* Does this property represent a synthetic property? A synthetic property is one we create during
* metamodel binding to represent a collection of columns but which does not represent a property
* physically available on the entity.
*
* @return True if synthetic; false otherwise.
*/
public boolean isSynthetic() {
return false;
}
public Type getType() throws MappingException {
return value.getType();
}
public int getColumnSpan() {
return value.getColumnSpan();
}
/**
* Delegates to {@link Value#getSelectables()}.
*/
public java.util.List getSelectables() {
return value.getSelectables();
}
/**
* Delegates to {@link Value#getColumns()}.
*
* @throws org.hibernate.AssertionFailure if the mapping involves formulas
*/
public java.util.List getColumns() {
return value.getColumns();
}
public String getName() {
return name;
}
public boolean isComposite() {
return value instanceof Component;
}
public Value getValue() {
return value;
}
public void resetUpdateable(boolean updateable) {
setUpdateable( updateable );
boolean[] columnUpdateability = getValue().getColumnUpdateability();
for (int i=0; i clazz) {
return getGetter( clazz ).getReturnTypeClass().isPrimitive();
}
public CascadeStyle getCascadeStyle() throws MappingException {
final Type type = value.getType();
if ( type instanceof AnyType ) {
return getCascadeStyle( cascade );
}
if ( type instanceof ComponentType ) {
return getCompositeCascadeStyle( (ComponentType) type, cascade );
}
else if ( type instanceof CollectionType ) {
final Collection collection = (Collection) value;
return getCollectionCascadeStyle( collection.getElement().getType(), cascade );
}
else {
return getCascadeStyle( cascade );
}
}
private static CascadeStyle getCompositeCascadeStyle(CompositeType compositeType, String cascade) {
if ( compositeType instanceof AnyType ) {
return getCascadeStyle( cascade );
}
else {
return getCompositeCascadeStyle( (ComponentType) compositeType, cascade );
}
}
private static CascadeStyle getCompositeCascadeStyle(ComponentType compositeType, String cascade) {
final int length = compositeType.getSubtypes().length;
for ( int i=0; i getMetaAttributes() {
return metaAttributes;
}
public MetaAttribute getMetaAttribute(String attributeName) {
return metaAttributes==null ? null : metaAttributes.get(attributeName);
}
public void setMetaAttributes(Map metas) {
this.metaAttributes = metas;
}
public boolean isValid(Mapping mapping) throws MappingException {
final Value value = getValue();
if ( value instanceof BasicValue && ( (BasicValue) value ).isDisallowedWrapperArray() ) {
throw new MappingException(
"The property " + persistentClass.getEntityName() + "#" + name +
" uses a wrapper type Byte[]/Character[] which indicates an issue in your domain model. " +
"These types have been treated like byte[]/char[] until Hibernate 6.2 which meant that " +
"null elements were not allowed, but on JDBC were processed like VARBINARY or VARCHAR. " +
"If you don't use nulls in your arrays, change the type of the property to byte[]/char[]. " +
"To allow explicit uses of the wrapper types Byte[]/Character[] which allows null element " +
"but has a different serialization format than before Hibernate 6.2, configure the " +
"setting " + AvailableSettings.WRAPPER_ARRAY_HANDLING + " to the value " + WrapperArrayHandling.ALLOW + ". " +
"To revert to the legacy treatment of these types, configure the value to " + WrapperArrayHandling.LEGACY + ". " +
"For more information on this matter, consult the migration guide of Hibernate 6.2 " +
"and the Javadoc of the org.hibernate.cfg.AvailableSettings.WRAPPER_ARRAY_HANDLING field."
);
}
return value.isValid( mapping );
}
public String toString() {
return getClass().getSimpleName() + '(' + name + ')';
}
public void setLazy(boolean lazy) {
this.lazy=lazy;
}
/**
* Is this property lazy in the "bytecode" sense?
*
* Lazy here means whether we initialize this field of the entity
* instance in its "base fetch group". It affects whether we list
* this property's columns in the SQL select for the owning entity
* when we load its "base fetch group". The actual value that is set
* varies based on the nature (basic, etc) of the property.
*
* @apiNote This method reports whether the property is considered
* part of the base fetch group based solely on the information in
* the mapping but {@link EnhancementHelper#includeInBaseFetchGroup}
* is also accounts for other details.
*/
public boolean isLazy() {
if ( value instanceof ToOne ) {
// For a many-to-one, this is always false. Whether the
// association is EAGER, PROXY or NO-PROXY we always want
// to select the foreign key
return false;
}
else {
return lazy;
}
}
public String getLazyGroup() {
return lazyGroup;
}
public void setLazyGroup(String lazyGroup) {
this.lazyGroup = lazyGroup;
}
public boolean isOptimisticLocked() {
return optimisticLocked;
}
public void setOptimisticLocked(boolean optimisticLocked) {
this.optimisticLocked = optimisticLocked;
}
public boolean isOptional() {
return optional;
}
public void setOptional(boolean optional) {
this.optional = optional;
}
public PersistentClass getPersistentClass() {
return persistentClass;
}
public void setPersistentClass(PersistentClass persistentClass) {
this.persistentClass = persistentClass;
}
public boolean isSelectable() {
return selectable;
}
public void setSelectable(boolean selectable) {
this.selectable = selectable;
}
/**
* @deprecated this method is no longer used
*/
@Deprecated(since = "6", forRemoval = true)
public String getAccessorPropertyName(RepresentationMode mode) {
return getName();
}
// todo : remove
@Internal
public Getter getGetter(Class clazz) throws MappingException {
return getPropertyAccessStrategy( clazz ).buildPropertyAccess( clazz, name, true ).getGetter();
}
// todo : remove
@Internal
public Setter getSetter(Class clazz) throws MappingException {
return getPropertyAccessStrategy( clazz ).buildPropertyAccess( clazz, name, true ).getSetter();
}
// todo : remove
@Internal
public PropertyAccessStrategy getPropertyAccessStrategy(Class clazz) throws MappingException {
final PropertyAccessStrategy propertyAccessStrategy = getPropertyAccessStrategy();
if ( propertyAccessStrategy != null ) {
return propertyAccessStrategy;
}
String accessName = getPropertyAccessorName();
if ( accessName == null ) {
if ( clazz == null || java.util.Map.class.equals( clazz ) ) {
accessName = "map";
}
else {
accessName = "property";
}
}
final RepresentationMode representationMode = clazz == null || java.util.Map.class.equals( clazz )
? RepresentationMode.MAP
: RepresentationMode.POJO;
return resolveServiceRegistry()
.requireService( PropertyAccessStrategyResolver.class )
.resolvePropertyAccessStrategy( clazz, accessName, representationMode );
}
ServiceRegistry resolveServiceRegistry() {
if ( getPersistentClass() != null ) {
return getPersistentClass().getServiceRegistry();
}
if ( getValue() != null ) {
return getValue().getServiceRegistry();
}
throw new HibernateException( "Could not resolve ServiceRegistry" );
}
public boolean isNaturalIdentifier() {
return naturalIdentifier;
}
public void setNaturalIdentifier(boolean naturalIdentifier) {
this.naturalIdentifier = naturalIdentifier;
}
public boolean isGeneric() {
return isGeneric;
}
public void setGeneric(boolean generic) {
this.isGeneric = generic;
}
public boolean isLob() {
return lob;
}
public void setLob(boolean lob) {
this.lob = lob;
}
public void addCallbackDefinitions(java.util.List callbackDefinitions) {
if ( callbackDefinitions != null && !callbackDefinitions.isEmpty() ) {
if ( this.callbackDefinitions == null ) {
this.callbackDefinitions = new ArrayList<>();
}
this.callbackDefinitions.addAll( callbackDefinitions );
}
}
public java.util.List getCallbackDefinitions() {
return callbackDefinitions == null ? emptyList() : unmodifiableList( callbackDefinitions );
}
public String getReturnedClassName() {
return returnedClassName;
}
public void setReturnedClassName(String returnedClassName) {
this.returnedClassName = returnedClassName;
}
public Generator createGenerator(RuntimeModelCreationContext context) {
return generatorCreator == null ? null :
generatorCreator.createGenerator( new PropertyGeneratorCreationContext( context ) );
}
public Property copy() {
final Property property = this instanceof SyntheticProperty ? new SyntheticProperty() : new Property();
property.setName( getName() );
property.setValue( getValue() );
property.setCascade( getCascade() );
property.setUpdateable( isUpdateable() );
property.setInsertable( isInsertable() );
property.setSelectable( isSelectable() );
property.setOptimisticLocked( isOptimisticLocked() );
property.setValueGeneratorCreator( getValueGeneratorCreator() );
property.setPropertyAccessorName( getPropertyAccessorName() );
property.setPropertyAccessStrategy( getPropertyAccessStrategy() );
property.setLazy( isLazy() );
property.setLazyGroup( getLazyGroup() );
property.setOptional( isOptional() );
property.setMetaAttributes( getMetaAttributes() );
property.setPersistentClass( getPersistentClass() );
property.setNaturalIdentifier( isNaturalIdentifier() );
property.setGeneric( isGeneric() );
property.setLob( isLob() );
property.addCallbackDefinitions( getCallbackDefinitions() );
property.setReturnedClassName( getReturnedClassName() );
return property;
}
private class PropertyGeneratorCreationContext implements GeneratorCreationContext {
private final RuntimeModelCreationContext context;
public PropertyGeneratorCreationContext(RuntimeModelCreationContext context) {
this.context = context;
}
@Override
public Database getDatabase() {
return context.getMetadata().getDatabase();
}
@Override
public ServiceRegistry getServiceRegistry() {
return context.getBootstrapContext().getServiceRegistry();
}
@Override
public String getDefaultCatalog() {
return context.getSessionFactoryOptions().getDefaultCatalog();
}
@Override
public String getDefaultSchema() {
return context.getSessionFactoryOptions().getDefaultSchema();
}
@Override
public PersistentClass getPersistentClass() {
return persistentClass;
}
@Override
public Property getProperty() {
return Property.this;
}
}
}