Package: Fetch

Fetch

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: * Represents a join-fetched association or attribute.
22: *
23: * @param <Z>
24: * the source type of the fetch
25: * @param <X>
26: * the target type of the fetch
27: */
28: public interface Fetch<Z, X> extends FetchParent<Z, X> {
29:         /**
30:          * Return the metamodel attribute corresponding to the fetch join.
31:          *
32:          * @return metamodel attribute for the join
33:          */
34:         Attribute<? super Z, ?> getAttribute();
35:
36:         /**
37:          * Return the parent of the fetched item.
38:          *
39:          * @return fetch parent
40:          */
41:         FetchParent<?, Z> getParent();
42:
43:         /**
44:          * Return the join type used in the fetch join.
45:          *
46:          * @return join type
47:          */
48:         JoinType getJoinType();
49: }