Язык предикатов
Предикат описывает условие, которое для проверяемого значения даёт результат true или false. В ecos-records предусмотрены JSON-представление и модель классов для работы с предикатами на Java/Kotlin.
Ниже описана реализация ecos-records 3.60.0-SNAPSHOT. Следует различать:
модель предиката и её сериализацию;
локальную проверку через
PredicateService.isMatch, фильтрацию и сортировку черезfilter/filterAndSort;выполнение поискового запроса целевым Records DAO или преобразователем языка запроса.
Набор поддерживаемых операций и особенности сравнения при поиске определяются источником. Локальная проверка использует DefaultValueComparator либо переданный пользователем ValueComparator.
JAVA представление
Диаграмма показывает основные связи классов; VoidPredicate и метод copy на ней не представлены. В реализации значение ValuePredicate хранится как DataValue.
Класс |
Описание |
|---|---|
|
Базовый интерфейс с методом копирования |
|
Предикат, связанный с атрибутом |
|
Проверка пустого значения атрибута |
|
Сравнение атрибута со значением. Операция задаётся |
|
Отрицание вложенного предиката |
|
Объединение нескольких предикатов |
|
Логическое И |
|
Логическое ИЛИ |
|
Предикат без условий; в локальной проверке обычного элемента соответствует истине |
JSON представление
{
"t": "and",
"val": [
{
"t": "or",
"val": [
{"t": "contains", "att": "country", "val": "milan"},
{"t": "contains", "att": "state", "val": "milan"},
{"t": "contains", "att": "name", "val": "milan"}
]
}
]
}
Поле t задаёт тип предиката, att — имя атрибута, val — значение или вложенные предикаты. Не все операции используют все три поля. Для чтения поддерживаются также сокращения a вместо att и v вместо val; при сериализации используются канонические имена att и val.
Если t отсутствует или пуст, создаётся VoidPredicate, который сериализуется как {}. Неизвестный непустой тип вызывает ошибку Type is unknown.
Для преобразования модели в JSON и обратно используется настроенный Json mapper. Методов writeJson/readJson у PredicateService нет.
String predicateStr = Json.getMapper().toString(predicate);
Predicate restoredPredicate = Json.getMapper().read(predicateStr, Predicate.class);
Получение предиката из RecordsQuery:
Predicate predicate = recordsQuery.getQuery(Predicate.class);
Примечание
При сериализации выполняется оптимизация предиката. Поэтому после JSON → модель → JSON структура может измениться: удаляются лишние вложения, нормализуются имена полей, сокращения starts/ends представляются через like. Исходный текст JSON не сохраняется побайтово.
Типы предикатов
Ниже приведены операции модели. Детали сравнения в следующем разделе относятся к стандартному локальному comparator; поведение SQL/FTS-поиска нужно учитывать отдельно.
Тип |
Назначение |
Пример JSON |
|---|---|---|
|
Строка начинается с указанного значения; при чтении преобразуется в |
|
|
Строка заканчивается указанным значением; при чтении преобразуется в |
|
|
Объединение массива предикатов по ИЛИ |
|
|
Объединение массива предикатов по И |
|
|
Проверка пустого значения атрибута |
|
|
Отрицание одного предиката в |
|
|
Равенство с учётом правил comparator |
|
|
Больше |
|
|
Больше или равно |
|
|
Меньше |
|
|
Меньше или равно |
|
|
Сопоставление строки с шаблоном: |
|
|
Значение атрибута равно одному из элементов массива |
|
|
Для строки — наличие подстроки, для массива — наличие равного элемента |
|
Отрицание поддерживаемого типа можно записать через префикс not-. Например:
{"t":"not-eq","att":"title","val":"Contract"}
Десериализатор преобразует его в not с вложенным eq.
Особенности локального сравнения
В DefaultValueComparator:
eqне является строгим сравнением JSON-типов: числовые строки могут сравниваться с числами; для чисел используется допуск1e-7.Строковый поиск
containsнечувствителен к регистру. Для массива сравниваются элементы черезisEquals; поиск подстроки в каждом элементе массива не выполняется.Для объекта и строкового аргумента
containsпроверяет строковые поля объекта. Приeqобъект также может сравниваться со строковыми значениями своих полей.inожидает массив вval; для другого типаvalвозвращаетсяfalse.likeсравнивает строки без учёта регистра:%заменяется на.*,_— на., затем применяется регулярное выражение ко всей строке. Остальные метасимволы регулярных выражений не экранируются, поэтому это не полная копия SQL LIKE.emptyпроверяетnullи пустоту значения согласно его типу.При пустом или неподдерживаемом значении
starts/endsresolver возвращаетalwaysTrue.При прямом локальном вычислении пустые
andиorсчитаются истинными. Это особенность реализации, а не математическое правило пустого ИЛИ.
Поисковый источник может использовать собственный comparator или преобразование в SQL/FTS. Из локального результата нельзя выводить полную эквивалентность поисковому запросу.
Дополнительные возможности предикатов
Даты и диапазоны
Для сравнения абсолютных дат используйте значения ISO 8601 с часовым поясом. Стандартный comparator распознаёт Instant-строки с T и окончанием Z при сравнении больше/меньше; в иных случаях применяются его общие правила преобразования и сравнения.
Диапазон с включёнными границами можно выразить через and с ge и le. Например, от 2020-01-01 00:00 UTC до 2020-02-01 00:00 UTC включительно:
{
"t": "and",
"val": [
{"t":"ge","att":"_created","val":"2020-01-01T00:00:00Z"},
{"t":"le","att":"_created","val":"2020-02-01T00:00:00Z"}
]
}
Для относительного периода можно заранее вычислить абсолютные границы. Пример для последних десяти суток:
const to = new Date();
const from = new Date(to.getTime() - 10 * 24 * 60 * 60 * 1000);
const predicate = {
t: 'and',
val: [
{ t: 'ge', att: '_created', val: from.toISOString() },
{ t: 'le', att: '_created', val: to.toISOString() }
]
};
Примечание
Строки -P10D, date/duration, $NOW и $TODAY не разбираются как относительные даты или диапазоны стандартным PredicateService этой версии. Их применение требует явной поддержки преобразователя конкретного источника. Аналогично, перевод предикатов в FTS и его шаблоны определяются Alfresco-интеграцией, а не JSON-моделью ecos-records.
Дебаг предикатов и отладка
Отладка предикатов
Источник predicate входит в стандартные DAO ecos-records и позволяет локально проверить условие для записи. Префикс приложения, например uiserv/, выбирает место выполнения диагностики.
Проверить один предикат:
await Records.queryOne({
sourceId: 'uiserv/predicate',
query: {
record: 'emodel/your-type@doc-id',
predicate: {
t: 'not',
val: { t: 'eq', att: '_status?str', val: 'Canceled' }
}
}
}, 'result?bool');
record и predicate — одиночные формы полей records и predicates. Для каждой записи источник возвращает поле record и список result с одним булевым значением на предикат. Для нескольких предикатов передавайте predicates и запрашивайте result[]?bool.
Диагностика загружает нужные атрибуты и вызывает локальный PredicateService. Она не проверяет преобразование условия в SQL/FTS целевого источника.
Загрузить значения сравниваемых атрибутов:
await Records.get('emodel/your-type@doc-id').load([
'_status?str',
'_status?disp',
'_roles.isCurrentUserMemberOf.author?bool',
'_roles.isCurrentUserMemberOf.admin?bool'
]);
Замените ссылку, статусы и роли значениями своей установки. Наличие этих атрибутов и их представления определяются источником записи.
Отображение кнопки при определённых условиях, описанных предикатом
Если настройка кнопки принимает предикат, можно задать условие, исключающее несколько статусов. В этом примере _status?str запрашивает строковый код статуса, предоставляемый источником. Внешний вид и применение условия определяются UI и настройкой действия.
Пример в YAML:
t: not
val:
t: in
att: _status?str
val:
- draft
- Canceled
- Rejected