[LIB-5] Site sources of snooker-score-api
[snooker-score-api.git] / src / site / ru / apt / examples / use-sort-in-collections.apt.vm
1  ------
2  Использование сортировки полученных данных
3  ------
4  Dmitry Samoshin aka gotty
5  ------
6  2017-01-27
7  ------
8
9 ~~ Copyright (c) 2017. Developed by Hedgecode.
10 ~~
11 ~~ Licensed under the Apache License, Version 2.0 (the "License");
12 ~~ you may not use this file except in compliance with the License.
13 ~~ You may obtain a copy of the License at
14 ~~
15 ~~   http://www.apache.org/licenses/LICENSE-2.0
16 ~~
17 ~~ Unless required by applicable law or agreed to in writing, software
18 ~~ distributed under the License is distributed on an "AS IS" BASIS,
19 ~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20 ~~ See the License for the specific language governing permissions and
21 ~~ limitations under the License.
22
23 ~~ NOTE: For help with the syntax of this file, see:
24 ~~ http://maven.apache.org/doxia/references/apt-format.html
25
26 Использование сортировки полученных данных
27
28   Данные, получаемые при вызовах API-методов основного интерфейса библиотеки, в большинстве своем
29   представляют классы-коллекции (<<<Players>>>, <<<Events>>>, <<<Matches>>>), к которым для удобства
30   дальнейшего использования в клиентских приложениях можно применять сортировку по определенным параметрам.
31
32   Ниже перечислены виды возможных сортировок для конкретных классов-коллекций.
33
34 ===
35
36   <<<Players>>> - класс-сущность, в котором содержится выборка игроков по определенным параметрам.\
37   Данный класс предоставляет два вида сортировки:
38
39   <<1.>> Сортировка игроков по имени.
40
41   <<2.>> Сортировка игроков по возрасту, как по убыванию, так и по возрастанию.
42
43   Ниже представлен Java-код, демонстрирующий все вышеуказанные способы сортировки:
44
45 +-------
46 Players players = Snooker.API().getPlayers(...);
47 ...
48 players.sortByName();
49 ...
50 players.sortByAge();
51 players.sortByAgeDesc();
52 ...
53 +-------
54
55 ===
56
57   <<<Events>>> - класс-сущность, в котором содержится выборка турниров по определенным параметрам.
58
59   Ниже представлен Java-код, демонстрирующий сортировку турниров по дате:
60
61 +-------
62 Events events = Snooker.API().getSeasonEvents((...);
63 ...
64 events.sortByDate();
65 ...
66 +-------
67
68 ===
69
70   <<<Matches>>> - класс-сущность, в котором содержится выборка матчей по определенным параметрам.\
71   Данный класс предоставляет два вида сортировки:
72
73   <<1.>> Сортировка матчей по номеру.\
74   Данный тип сортировки будет полезен тогда, когда выборка содержит все матчи отдельно взятого турнира.
75
76   <<2.>> Сортировка матчей по турнирам.\
77   Данный тип сортировки будет полезен тогда, когда выборка содержит все матчи отдельно взятого игрока за сезон в разных турнирах.
78
79   Ниже представлен Java-код, демонстрирующий все вышеуказанные способы сортировки:
80
81 +-------
82 Matches matches = Snooker.API().getEventMatches((...);
83 ...
84 matches.sortByNumber();
85 ...
86 matches.sortByEvent();
87 ...
88 +-------