org.hibernate.boot.model.source.spi.PluralAttributeIndexSource 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.Alpha1

/*
 * 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.boot.model.source.spi;

/**
 * Highly abstract concept of the index of an "indexed persistent collection".
 * More concretely (and generally more usefully) categorized as either:
 *     {@link PluralAttributeSequentialIndexSource} - for list/array indexes
 *     {@link PluralAttributeMapKeySource} - for map keys
 * 
 *
 */
public interface PluralAttributeIndexSource {
	PluralAttributeIndexNature getNature();

	/**
	 * Obtain information about the Hibernate index type ({@link org.hibernate.type.Type})
	 * for this plural attribute index.
	 *
	 * @return The Hibernate type information
	 */
	HibernateTypeSource getTypeInformation();

	String getXmlNodeName();
}