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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javax.persistence Show documentation

The Java Persistence API (JPA) : a standard interface-based Java model abstraction of persistence, developed by the JCP.

There is a newer version: 2.2.4

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.MapAttribute;
import java.util.Map;

/**
 * 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
 */
public interface MapJoin extends PluralJoin, V>
{
    /**
     * 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
     */
    MapJoin 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
     */
    MapJoin on(Predicate... restrictions);

    /**
     * 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();
}