Package: Order

Order

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: /**
18: * An object that defines an ordering over the query results.
19: */
20: public interface Order {
21:         /**
22:          * Switch the ordering.
23:          *
24:          * @return a new Order instance with the reversed ordering
25:          */
26:         Order reverse();
27:
28:         /**
29:          * Whether ascending ordering is in effect.
30:          *
31:          * @return boolean indicating whether ordering is ascending
32:          */
33:         boolean isAscending();
34:
35:         /**
36:          * Return the expression that is used for ordering.
37:          *
38:          * @return expression used for ordering
39:          */
40:         Expression<?> getExpression();
41: }