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

Go to download

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

There is a newer version: 1.0.2.Final

Show 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.Attribute;

/**
 * A join to an entity, embeddable, or basic type.
 *
 * @param  the source type of the join
 * @param  the target type of the join
 * @since Java Persistence 2.0
 */
public interface Join extends From {
	/**
	 * 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
	 */
	Join 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
	 */
	Join on(Predicate... restrictions);

	/**
	 * Return the predicate that corresponds to the ON
	 * restriction(s) on the join, or null if no ON condition
	 * has been specified.
	 * @return the ON restriction predicate
	 */
	Predicate getOn();

	/**
	 * Return the metamodel attribute corresponding to the join.
	 *
	 * @return metamodel attribute corresponding to the join
	 */
	Attribute getAttribute();

	/**
	 * Return the parent of the join.
	 *
	 * @return join parent
	 */
	From getParent();

	/**
	 * Return the join type.
	 *
	 * @return join type
	 */
	JoinType getJoinType();
}