Package: Join

Join

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 cz.cvut.kbss.jopa.model.metamodel.Attribute;
18:
19: /**
20: * A join to an entity, embeddable, or basic type.
21: *
22: * @param <Z>
23: * the source type of the join
24: * @param <X>
25: * the target type of the join
26: */
27: public interface Join<Z, X> extends From<Z, X> {
28:         /**
29:          * Return the metamodel attribute corresponding to the jo* @return metamodel
30:          * attribute corresponding to the join
31:          */
32:         Attribute<? super Z, ?> getAttribute();
33:
34:         /**
35:          * Return the parent of the join.
36:          *
37:          * @return join parent
38:          */
39:         From<?, Z> getParent();
40:
41:         /**
42:          * Return the join type.
43:          *
44:          * @return join type
45:          */
46:         JoinType getJoinType();
47: }