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

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

Clean-room definition of JPA APIs intended for use in developing Hibernate JPA implementation. See README.md for details

The newest version!

/*
 * Copyright (c) 2008, 2009, 2011 Oracle, Inc. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
 * which accompanies this distribution.  The Eclipse Public License is available
 * at http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution License
 * is available at http://www.eclipse.org/org/documents/edl-v10.php.
 */
package javax.persistence.criteria;

import javax.persistence.metamodel.ListAttribute;
import java.util.List;

/**
 * The ListJoin 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.List.
 *
 * @param  the source type of the join
 * @param  the element type of the target List
 * @since Java Persistence 2.0
 */
public interface ListJoin
		extends PluralJoin, E> {

	/**
	 * Modify the join to restrict the result according to the
	 * specified ON condition. Replaces the previous ON condition,
	 * if any.
	 * Return the join object
	 * @param restriction a simple or compound boolean expression
	 * @return the modified join object
	 */
	ListJoin on(Expression restriction);

	/**
	 * Modify the join to restrict the result according to the
	 * specified ON condition. Replaces the previous ON condition,
	 * if any.
	 * Return the join object
	 * @param restrictions zero or more restriction predicates
	 * @return the modified join object
	 */
	ListJoin on(Predicate... restrictions);

	/**
	 * Return the metamodel representation for the list attribute.
	 *
	 * @return metamodel type representing the List that is
	 *         the target of the join
	 */
	ListAttribute getModel();

	/**
	 * Create an expression that corresponds to the index of
	 * the object in the referenced association or element
	 * collection.
	 * This method must only be invoked upon an object that
	 * represents an association or element collection for
	 * which an order column has been defined.
	 *
	 * @return expression denoting the index
	 */
	Expression index();
}