src/site/ru/apt/usage.apt.vm

   1  ------
   2  Использование
   3  ------
   4  Dmitry Samoshin aka gotty
   5  ------
   6  2017-01-22
   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 * Подключение библиотеки для использования в Java-приложениях
  29
  30   Шаблон подключения данной библиотеки для разработки Java-приложений с
  31   использованием конфигурационного Maven-файла pom.xml представлен ниже:
  32
  33 +-----
  34 <project>
  35     ...
  36     <dependencies>
  37         <dependency>
  38             <groupId>${project.groupId}</groupId>
  39             <artifactId>${project.artifactId}</artifactId>
  40             <version>${project.version}</version>
  41         </dependency>
  42     </dependencies>
  43     ...
  44 </project>
  45 +-----
  46
  47   <<Примечание>>: Maven 3.0 будет выдавать предупреждение,
  48   если вы не укажите версию плагина.
  49
  50 * Работа с Java-кодом библиотеки
  51
  52   После подключения библиотеки к проекту можно начинать работать с её кодом.\
  53   Для того, чтобы получить экземпляр основного интерфейса библиотеки, нужно
  54   выполнить следующий код:
  55
  56 +-----
  57 SnookerScoreAPI api = Snooker.API();
  58 +-----
  59
  60   <<<SnookerScoreAPI>>> представляет собой интерфейс с набором всех основных методов,
  61   которые позволяют через объекты-сущности получить доступ к информации о сезонах,
  62   турнирах, матчах, игроках и их рейтингах.
  63
  64   Библиотека предоставляет две реализации вышеуказанного интерфейса: с кэшированием
  65   данных по игрокам и событиям (турнирам) внутри библиотеки и без кэширования.
  66   Реализация интерфейса с кэшированием является реализацией "по умолчанию".\
  67   Доступ к каждой из двух реализаций интерфейса может быть получен путём выполнения
  68   следующих вызовов:
  69
  70 +-----
  71 SnookerScoreAPI cachedApi = Snooker.cachedAPI(); /* API with cache */
  72 ...
  73 SnookerScoreAPI uncachedApi = Snooker.uncachedAPI(); /* API without cache */
  74 +-----
  75
  76   Дальнейшая работа с библиотекой представляет собой последовательность вызовов методов
  77   интерфейса <<<SnookerScoreAPI>>> для получения списков турниров, игроков, текущих матчей
  78   и прочей статистической информации.\
  79   Например, чтобы получить информацию по матчам, проходящим в данный момент, достаточно
  80   выполнить следующий код:
  81
  82 +-----
  83 SnookerScoreAPI api = Snooker.API();
  84 OngoingMatches matches = api.getOngoingMatches();
  85 +-----
  86
  87   Описание работы большинства методов интерфейса можно найти в разделе {{{./faq.html}ЧаВо}},
  88   а на страницах с примерами рассмотрены наиболее часто встречающиеся ситуации.
  89   Сигнатура методов, а также информация по другим сущностям библиотеки, представлена в
  90   {{{./apidocs/}JavaDoc}}.
  91
  92 * Запуск библиотеки из командной строки
  93
  94   В данной библиотеке имеется возможность произвести запуск из командной строки для проверки
  95   корректности соединения с информационным порталом {{{http://snooker.org/}snooker.org}}.
  96   Запуск библиотеки из командной строки осуществляется следующим образом:
  97
  98 +-----
  99 java -jar ${project.artifactId}-${project.version}.jar
 100 +-----
 101
 102   Если программа отработает корректно, то можно будет увидеть список текущих и предстоящих
 103   турниров по снукеру.\
 104   Примерный результат вывода программы представлен ниже:
 105
 106 +-----
 107 ********************************************************************************
 108                     Welcome to Hedgecode Snooker Score API!
 109                 -----------------------------------------------
 110          It is an API library for portal snooker.org, which contains
 111       the results of snooker competitions and other snooker information.
 112     This library provides a set of entity objects that can be used in client
 113     applications (to inform about the results of snooker), developed in Java.
 114 ********************************************************************************
 115   Current Snooker Events:
 116      China Open Qualifiers [24.01.2017 - 27.01.2017] (England, Preston)
 117 ********************************************************************************
 118   Upcoming Snooker Events:
 119      German Masters [01.02.2017 - 05.02.2017] (Germany, Berlin)
 120      World Grand Prix [06.02.2017 - 12.02.2017] (England, Preston)
 121      Welsh Open [13.02.2017 - 19.02.2017] (Wales, Cardiff)
 122      Connie Gough Memorial Trophy [18.02.2017 - 18.02.2017] (England, Dunstable)
 123      Championship League - Group 5 [20.02.2017 - 21.02.2017] (England, Coventry)
 124 ********************************************************************************
 125 +-----