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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jpa-api Show documentation
Hibernate developmental JSR 317 (Java Persistence API 2.0) contracts. Used to allow incremental implementation of features on the way to full JPA 2.0 support.
The newest version!
// $Id: From.java 17233 2009-08-05 18:10:41Z [email protected] $
// EJB3 Specification Copyright 2004-2009 Sun Microsystems, Inc.
package javax.persistence.criteria;

import javax.persistence.metamodel.SingularAttribute;
import javax.persistence.metamodel.CollectionAttribute;
import javax.persistence.metamodel.ListAttribute;
import javax.persistence.metamodel.MapAttribute;
import javax.persistence.metamodel.SetAttribute;

/**
 * Represents a bound type, usually an entity that appears in
 * the from clause, but may also be an embeddable belonging to
 * an entity in the from clause.
 * Serves as a factory for Joins of associations, embeddables and
 * collections belonging to the type, and for Paths of attributes
 * belonging to the type.
 * @param 
 * @param 
 */
public interface From extends Path, FetchParent {

    /**
     *  Return the joins that have been made from this type.
     *  @return joins made from this type
     */
    java.util.Set> getJoins();

    /**
     *  Join to the specified single-valued attribute using an
     *  inner join.
     *  @param attribute  target of the join
     *  @return the resulting join
     */
     Join join(SingularAttribute attribute);

    /**
     *  Join to the specified single-valued attribute using the
     *  given join type.
     *  @param attribute  target of the join
     *  @param jt  join type
     *  @return the resulting join
     */
     Join join(SingularAttribute attribute, JoinType jt);

    /**
     *  Join to the specified Collection-valued attribute using
     *  an inner join.
     *  @param collection  target of the join
     *  @return the resulting join
     */
     CollectionJoin join(CollectionAttribute collection);

    /**
     *  Join to the specified Set-valued attribute using an inner
     *  join.
     *  @param set  target of the join
     *  @return the resulting join
     */
     SetJoin join(SetAttribute set);

    /**
     *  Join to the specified List-valued attribute using an inner
     *  join.
     *  @param list  target of the join
     *  @return the resulting join
     */
     ListJoin join(ListAttribute list);

    /**
     *  Join to the specified Map-valued attribute using an inner
     *  join.
     *  @param map  target of the join
     *  @return the resulting join
     */
     MapJoin join(MapAttribute map);

    /**
     *  Join to the specified Collection-valued attribute
     *  using the given join type.
     *  @param collection  target of the join
     *  @param jt  join type
     *  @return the resulting join
     */
     CollectionJoin join(CollectionAttribute collection, JoinType jt);

    /**
     *  Join to the specified Set-valued attribute using the given
     *  join type.
     *  @param set  target of the join
     *  @param jt  join type
     *  @return the resulting join
     */
     SetJoin join(SetAttribute set, JoinType jt);

    /**
     *  Join to the specified List-valued attribute using the
     *  given join type.
     *  @param list  target of the join
     *  @param jt  join type
     *  @return the resulting join
     */
     ListJoin join(ListAttribute list, JoinType jt);

    /**
     *  Join to the specified Map-valued attribute using the
     *  given join type.
     *  @param map  target of the join
     *  @param jt  join type
     *  @return the resulting join
     */
     MapJoin join(MapAttribute map, JoinType jt);


    //String-based:

    /**
     * Join to the specified attribute using an inner join.
	 *
	 * @param  The type of the source of the join; note that this method-local  hides the  defined as a type
	 * param to {@link From}; the expectation is that the two types match.
	 * @param  The type of the joined attribute/association
     * @param attributeName  name of the attribute for the
     *               target of the join
     * @return the resulting join
     * @throws IllegalArgumentException if attribute of the given
     *          name does not exist
     */
     Join join(String attributeName);

    /**
     *  Join to the specified Collection-valued attribute using an
     *  inner join.
	 *
	 * @param  The type of the source of the join; note that this method-local  hides the  defined as a type
	 * param to {@link From}; the expectation is that the two types match.
	 * @param  The type of the joined attribute/association
     * @param attributeName  name of the attribute for the
     *               target of the join
     * @return the resulting join
     * @throws IllegalArgumentException if attribute of the given
     *          name does not exist
     */
     CollectionJoin joinCollection(String attributeName);

    /**
     *  Join to the specified Set-valued attribute using an inner
     *  join.
	 *
	 * @param  The type of the source of the join; note that this method-local  hides the  defined as a type
	 * param to {@link From}; the expectation is that the two types match.
	 * @param  The type of the joined attribute/association
     * @param attributeName  name of the attribute for the
     *               target of the join
     * @return the resulting join
     * @throws IllegalArgumentException if attribute of the given
     *          name does not exist
     */
     SetJoin joinSet(String attributeName);

    /**
     *  Join to the specified List-valued attribute using an inner
     *  join.
	 *
	 * @param  The type of the source of the join; note that this method-local  hides the  defined as a type
	 * param to {@link From}; the expectation is that the two types match.
	 * @param  The type of the joined attribute/association
     * @param attributeName  name of the attribute for the
     *               target of the join
     * @return the resulting join
     * @throws IllegalArgumentException if attribute of the given
     *          name does not exist
     */
     ListJoin joinList(String attributeName);

    /**
     *  Join to the specified Map-valued attribute using an inner
     *  join.
	 *
	 * @param  The type of the source of the join; note that this method-local  hides the  defined as a type
	 * param to {@link From}; the expectation is that the two types match.
	 * @param  The type of the key of the joined map.
	 * @param  The type of the value of the joined map.
     * @param attributeName  name of the attribute for the
     *               target of the join
     * @return the resulting join
     * @throws IllegalArgumentException if attribute of the given
     *          name does not exist
     */
     MapJoin joinMap(String attributeName);


    /**
     *  Join to the specified attribute using the given
	 *  join type.
	 *
	 * @param  The type of the source of the join; note that this method-local  hides the  defined as a type
	 * param to {@link From}; the expectation is that the two types match.
	 * @param  The type of the joined attribute/association
     * @param attributeName  name of the attribute for the
     *               target of the join
     * @param jt  join type
     * @return the resulting join
     * @throws IllegalArgumentException if attribute of the given
     *          name does not exist
     */
     Join join(String attributeName, JoinType jt);

    /**
     *  Join to the specified Collection-valued attribute using
     *  the given join type.
	 *
	 * @param  The type of the source of the join; note that this method-local  hides the  defined as a type
	 * param to {@link From}; the expectation is that the two types match.
	 * @param  The type of the joined attribute/association
     * @param attributeName  name of the attribute for the
     *               target of the join
     * @param jt  join type
     * @return the resulting join
     * @throws IllegalArgumentException if attribute of the given
     *          name does not exist
     */
     CollectionJoin joinCollection(String attributeName, JoinType jt);

    /**
     *  Join to the specified Set-valued attribute using
     *  the given join type.
	 *
	 * @param  The type of the source of the join; note that this method-local  hides the  defined as a type
	 * param to {@link From}; the expectation is that the two types match.
	 * @param  The type of the joined attribute/association
     * @param attributeName  name of the attribute for the
     *               target of the join
     * @param jt  join type
     * @return the resulting join
     * @throws IllegalArgumentException if attribute of the given
     *          name does not exist
     */
     SetJoin joinSet(String attributeName, JoinType jt);

    /**
     *  Join to the specified List-valued attribute using
     *  the given join type.
	 *
	 * @param  The type of the source of the join; note that this method-local  hides the  defined as a type
	 * param to {@link From}; the expectation is that the two types match.
	 * @param  The type of the joined attribute/association
     * @param attributeName  name of the attribute for the
     *               target of the join
     * @param jt  join type
     * @return the resulting join
     * @throws IllegalArgumentException if attribute of the given
     *          name does not exist
     */
     ListJoin joinList(String attributeName, JoinType jt);

    /**
     *  Join to the specified Map-valued attribute using
     *  the given join type.
	 *
	 * @param  The type of the source of the join; note that this method-local  hides the  defined as a type
	 * param to {@link From}; the expectation is that the two types match.
	 * @param  The type of the key of the joined map.
	 * @param  The type of the value of the joined map.
     * @param attributeName  name of the attribute for the
     *               target of the join
     * @param jt  join type
     * @return the resulting join
     * @throws IllegalArgumentException if attribute of the given
     *          name does not exist
     */
     MapJoin joinMap(String attributeName, JoinType jt);
}