Package: MapJoin

MapJoin

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.Map;
18:
19: import cz.cvut.kbss.jopa.model.metamodel.MapAttribute;
20:
21: /**
22: * The MapJoin 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.Map.
25: *
26: * @param <Z>
27: * the source type of the join
28: * @param <K>
29: * the type of the target Map key
30: * @param <V>
31: * the type of the target Map value
32: */
33: public interface MapJoin<Z, K, V> extends PluralJoin<Z, Map<K, V>, V> {
34:         /**
35:          * Return the metamodel representation for the map attribute.
36:          *
37:          * @return metamodel type representing the Map that is
38:          *
39:          * the target of the join
40:          */
41:         MapAttribute<? super Z, K, V> getModel();
42:
43:         /**
44:          * Create a path expression that corresponds to the map key.
45:          *
46:          * @return path corresponding to map key
47:          */
48:         Path<K> key();
49:
50:         /**
51:          * Create a path expression that corresponds to the map value. This method
52:          * is for stylistic use only: it just returns this.
53:          *
54:          * @return path corresponding to the map value
55:          */
56:         Path<V> value();
57:
58:         /**
59:          * Create an expression that corresponds to the map entry.
60:          *
61:          * @return expression corresponding to the map entry
62:          */
63:         Expression<Map.Entry<K, V>> entry();
64: }