org.hibernate.metamodel.mapping.CollectionPart 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.Beta1

/*
 * 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.mapping;

import org.hibernate.sql.results.spi.Fetchable;

/**
 * @author Steve Ebersole
 */
public interface CollectionPart extends ModelPart, Fetchable {
	enum Nature {
		ELEMENT( "{element}" ),
		INDEX( "{index}" ),
		ID( "{collection-id}" );

		private final String name;

		Nature(String name) {
			this.name = name;
		}

		public String getName() {
			return name;
		}

		public static Nature fromName(String name) {
			if ( "key".equals( name ) || "{key}".equals( name )
					|| "keys".equals( name ) || "{keys}".equals( name )
					|| "index".equals( name ) || "{index}".equals( name )
					|| "indices".equals( name ) || "{indices}".equals( name ) ) {
				return INDEX;
			}

			if ( "element".equals( name ) || "{element}".equals( name )
					|| "elements".equals( name ) || "{elements}".equals( name )
					|| "value".equals( name ) || "{value}".equals( name )
					|| "values".equals( name ) || "{values}".equals( name ) ) {
				return ELEMENT;
			}

			if ( ID.name.equals( name ) ) {
				return ID;
			}

			throw new IllegalArgumentException(
					"Unrecognized CollectionPart Nature name [" + name
							+ "]; expecting `" + ELEMENT.name + "` or `"
							+ INDEX.name + "`"
			);
		}
	}

	Nature getNature();

	MappingType getPartTypeDescriptor();

	@Override
	default String getPartName() {
		return getNature().getName();
	}
}