Package: ListJoin

ListJoin

Coverage

1: /**
2: * Copyright (C) 2016 Czech Technical University in Prague
3: *
4: * This program is free software: you can redistribute it and/or modify it under
5: * the terms of the GNU General Public License as published by the Free Software
6: * Foundation, either version 3 of the License, or (at your option) any
7: * later version.
8: *
9: * This program is distributed in the hope that it will be useful, but WITHOUT
10: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11: * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
12: * details. You should have received a copy of the GNU General Public License
13: * along with this program. If not, see <http://www.gnu.org/licenses/>.
14: */
15: package cz.cvut.kbss.jopa.model.query.criteria;
16:
17: import java.util.List;
18:
19: import cz.cvut.kbss.jopa.model.metamodel.ListAttribute;
20:
21: /**
22: * The ListJoin interface is the type of the result of joining to a collection
23: * over an association or element collection that has been specified as a
24: * java.util.List.
25: *
26: * @param <Z>
27: * the source type of the join
28: * @param <E>
29: * the element type of the target List
30: */
31: public interface ListJoin<Z, E> extends PluralJoin<Z, List<E>, E> {
32:         /**
33:          * Return the metamodel representation for the list attribute.
34:          *
35:          * @return metamodel type representing the List that is
36:          *
37:          * the target of the join
38:          */
39:         ListAttribute<? super Z, E> getModel();
40:
41:         /**
42:          * Create an expression that corresponds to the index of the object in the
43:          * referenced association or element collection. This method must only be
44:          * invoked upon an object that represents an association or element
45:          * collection for which an order column has been defined.
46:          *
47:          * @return expression denoting the index
48:          */
49:         Expression<Integer> index();
50: }