javax.persistence.criteria.MapJoin Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hibernate-jpa-2.0-api Show documentation

Hibernate definition of the Java Persistence 2.0 (JSR 317) API.

There is a newer version: 1.0.1.Final

Show newest version

// $Id: MapJoin.java 17752 2009-10-15 01:19:21Z [email protected] $
// EJB3 Specification Copyright 2004-2009 Sun Microsystems, Inc.
package javax.persistence.criteria;

import java.util.Map;
import javax.persistence.metamodel.MapAttribute;

/**
 * The MapJoin interface is the type of the result of
 * joining to a collection over an association or element
 * collection that has been specified as a java.util.Map.
 *
 * @param  the source type of the join
 * @param  the type of the target Map key
 * @param  the type of the target Map value
 * @since Java Persistence 2.0
 */
public interface MapJoin extends PluralJoin, V> {
	/**
	 * Return the metamodel representation for the map attribute.
	 *
	 * @return metamodel type representing the Map that is
	 *         the target of the join
	 */
	MapAttribute getModel();

	/**
	 * Create a path expression that corresponds to the map key.
	 *
	 * @return path corresponding to map key
	 */
	Path key();

	/**
	 * Create a path expression that corresponds to the map value.
	 * This method is for stylistic use only: it just returns this.
	 *
	 * @return path corresponding to the map value
	 */
	Path value();

	/**
	 * Create an expression that corresponds to the map entry.
	 *
	 * @return expression corresponding to the map entry
	 */
	Expression> entry();
}