FMPQuery.Builder

Описание

Интерфейс FMPQuery.Builder является конструктором интерфейса FMPQuery.

interface FMPQuery.Builder: FMPObject.Builder

Методы

Метод Описание

database

 Указание базы данных, в которой будет хранится кэш. 
fun database(database: FMPDatabase)

Параметры:

  • database. База данных.
transactions Указание списка транзакций, которые будут использованы при загрузке. 
fun transactions(transactions: List<FMPTransaction>)

Параметры:

  • transactions. Список транзакций.
select Добавление в SQL-запрос оператора SELECT. 
fun select(vararg columns: String)

Параметры:

  • columns. Список имен столбцов. Например: id, count(id).
from Добавление в SQL-запрос оператора FROM. Определяет, из какой таблицы будет выполняться запрос.

Примечание. Для загрузки с сервера у таблицы должен быть указан FMPResource.

fun from(table: FMPTable)

Параметры:

  • table. Таблица.
join Добавление в SQL-запрос оператора JOIN. 
fun join(table: FMPTable, join: Join = Join.INNER)

Параметры:

  • table. Таблица;

  • join. Вид JOIN-запроса.
on Добавление в SQL-запрос оператора ON. 
fun on(on: String)

Параметры:

  • on. ON-запрос.
using Добавление в SQL-запрос оператора USING. 
fun using(column: String)

Параметры:

  • column. Имя столбца.
where Добавление в SQL-запрос оператора WHERE. 
fun where(where: String)

Параметры:

  • where. Условие фильтрации. Для удобства можно использовать toString() у таблицы, например: $table.id = 10.
order Добавление в SQL-запрос оператора ORDER BY. 
fun order(columns: Map<String, Sort>)

Параметры:

  • columns. Условия сортировки, представляющие собой массив из кортежей с именем столбца column и соответствующим направлением сортировки, например: order(mapOf("id" to Sort.DESC)).
limit Добавление в SQL-запрос оператора LIMIT. 
fun limit(limit: Int, offset: Int)

Параметры:

  • limit. Число запрашиваемых строк;

  • offset. Число пропускаемых строк.
group Добавление в SQL-запрос оператора GROUP BY. 
fun group(by: String)

Параметры:

  • by. Список имен столбцов.
having Добавление в SQL-запрос оператора HAVING. 
fun having(condition: String)

Параметры:

  • condition. Условие.
pathForResume Указание пути к папке, в которой будет храниться кэш загрузки. 
fun pathForResume(path: String)

Параметры:

  • path. Путь к папке, в которой будет храниться кэш загрузки.

Методы, унаследованные от интерфейса FMPObject.Builder

Метод Описание
fromJSON Десериализация объекта из JSON. 
fun fromJSON(json: String): FMPObject

Параметры:

  • json. Объект в JSON.
build Построение экземпляра интерфейса. 
fun build(): FMPObject

См. также:

Фреймворк FMP | Интерфейсы