org.hibernate.metamodel.model.domain.spi.EmbeddedTypeDescriptor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hibernate-core Show documentation
Hibernate's core ORM functionality
There is a newer version: 7.0.0.Alpha2
/*
 * 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 http://www.gnu.org/licenses/lgpl-2.1.html
 */
package org.hibernate.metamodel.model.domain.spi;

import java.util.List;

import org.hibernate.NotYetImplementedFor6Exception;
import org.hibernate.boot.model.domain.spi.EmbeddedValueMappingImplementor;
import org.hibernate.boot.model.domain.spi.ManagedTypeMappingImplementor;
import org.hibernate.engine.spi.CascadeStyle;
import org.hibernate.engine.spi.SharedSessionContractImplementor;
import org.hibernate.metamodel.model.creation.spi.RuntimeModelCreationContext;
import org.hibernate.metamodel.model.domain.EmbeddedDomainType;
import org.hibernate.metamodel.model.relational.spi.Column;
import org.hibernate.type.descriptor.java.spi.EmbeddableJavaDescriptor;

/**
 * Mapping for an embeddable.
 * 
 * NOTE - the name is here is Embedded* as opposed to Embeddable* because it
 * really represents the specific usage of the embeddable, which is `@Embedded`
 * 
 * NOTE2 - this extends InheritanceCapable even though we currently do not support that, but we
 * know it is something we want to support at some point.
 *
 * @author Steve Ebersole
 */
public interface EmbeddedTypeDescriptor
		extends InheritanceCapable, EmbeddedContainer, EmbeddedDomainType,
		SimpleTypeDescriptor, EmbeddedValuedNavigable {

	Class[] STANDARD_CTOR_SIGNATURE = new Class[] {
			EmbeddedValueMappingImplementor.class,
			EmbeddedContainer.class,
			EmbeddedTypeDescriptor.class,
			String.class,
			SingularPersistentAttribute.Disposition.class,
			RuntimeModelCreationContext.class
	};

	default String getRoleName() {
		return getNavigableRole().getFullPath();
	}

	List collectColumns();

	@Override
	EmbeddableJavaDescriptor getJavaTypeDescriptor();

	@Override
	EmbeddedContainer getContainer();

	@Override
	default boolean finishInitialization(
			Object bootReference,
			RuntimeModelCreationContext creationContext) {
		// todo (6.0) : define this delegated `#finishInitialization` to return boolean as well?
		finishInitialization( (ManagedTypeMappingImplementor) bootReference, creationContext );
		return true;
	}

	@Override
	@SuppressWarnings("unchecked")
	default Class getJavaType() {
		return getJavaTypeDescriptor().getJavaType();
	}

	@Override
	default boolean canCompositeContainCollections() {
		return getContainer().canCompositeContainCollections();
	}

	@Override
	default String asLoggableText() {
		return "EmbeddableMapper(" + getJavaType() + " [" + getRoleName() + "])";
	}

	@Override
	default int getNumberOfJdbcParametersForRestriction() {
		return getEmbeddedDescriptor().getNumberOfJdbcParametersForRestriction();
	}


	@Override
	default boolean isSubclassTypeName(String name) {
		return false;
	}

	default T instantiate(SharedSessionContractImplementor session) {
		throw new NotYetImplementedFor6Exception( getClass() );
	}


	// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	// todo (6.0) : everything below relates to the "attribute position" discussion


	/**
	 * Get the nullability of the properties of this class
	 */
	boolean[] getPropertyNullability();

	/**
	 * Get the cascade style of a particular property
	 */
	CascadeStyle getCascadeStyle(int i);


}