Package: Join

Join

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