Package: MapJoin

MapJoin

Coverage

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