Платформа CUBA. Руководство по разработке приложений
4.5.2.1.9. Filter

include - обязательный атрибут, содержит регулярное выражение, которому должно соответствовать имя атрибута сущности.

exclude - содержит регулярное выражение, при соответствии которому атрибут сущности исключается из ранее включенных с помощью include.

Коллекции (@OneToMany, @ManyToMany).

Атрибуты, не имеющие локализованного названия.

Атрибут version.

name - обязательный атрибут, содержит имя включаемого атрибута сущности. Может быть путем (через ".") по графу сущностей. Например:

<filter id="transactionsFilter" datasource="transactionDs" applyTo="table">
    <properties include=".*" exclude="(masterTransaction)|(authCode)"/>
    <property name="creditCard.maskedPan" caption="msg://EmbeddedCreditCard.maskedPan"/>
    <property name="creditCard.startDate" caption="msg://EmbeddedCreditCard.startDate"/>
</filter>

caption - локализованное название атрибута сущности для отображения условия фильтра. Как правило, представляет из себя строку с префиксом msg:// по правилам MessageTools.loadString().

Если в атрибуте name указан путь (через ".") по графу сущностей, то атрибут caption является обязательным.

paramWhere − задает выражение на JPQL для отбора списка значений параметра условия, если параметр является связанной сущностью. Вместо алиаса сущности параметра в выражении нужно использовать метку (placeholder) {E}.

Например, предположим, что сущность Car имеет ссылку на сущность Model. Тогда список возможных значений параметра может быть ограничен только моделями Audi:

<filter id="carsFilter" datasource="carsDs">
    <property name="model" paramWhere="{E}.manufacturer = 'Audi'"/>
</filter>

В выражении JPQL можно использовать параметры экрана, атрибуты сессии, а также компоненты экрана, в том числе отображающие другие параметры. Правила задания параметров запроса описаны в Раздел 4.5.3.2, «Запросы в CollectionDatasourceImpl».

Пример использования параметра сессии и параметра экрана:

{E}.createdBy = :session$userLogin and {E}.name like :param$groupName

Используя paramWhere можно вводить зависимости между параметрами. Например, предположим, что Manufacturer является отдельной сущностью. То есть Car ссылается на Model, которая в свою очередь ссылается на Manufacturer. Тогда для фильтра по Car можно создать два условия: первое для выбора Manufacturer и второе для выбора Model. Чтобы ограничить список моделей выбранным перед этим производителем, добавьте в выражение paramWhere параметр:

{E}.manufacturer.id = :component$filter.model_manufacturer90062

Здесь параметр ссылается на компонент, отображающий параметр Manufacturer. Имя компонента, отображающего параметр условия, можно узнать, вызвав контекстное меню на строке таблицы условий в редакторе фильтра:

paramView − задает представление, с которым будет загружаться список значений параметра условия, если параметр является связанной сущностью. Например, _local. Если не указано, используется _minimal.

name − обязательный атрибут - имя условия.

caption − обязательный атрибут - локализованное название условия. Как правило, представляет из себя строку с префиксом msg:// по правилам MessageTools.loadString().

paramClass − Java-класс параметра условия. Если параметр отсутствует, то данный атрибут не обязателен.

inExpr − должен быть установлен в true, если выражение JPQL содержит условие in (?). При этом пользователь будет иметь возможность ввести несколько значений параметра данного условия.

join − необязательный атрибут для задания строки, которая будет добавлена в секцию from запроса источника данных. Это может потребоваться для создания условия по атрибуту связанной коллекции. Значение данного атрибута должно включать в себя предложения join или left join.

Например, предположим что сущность Car имеет атрибут repairs, который представляет собой коллекцию экземпляров связанной сущности Repair. Тогда для фильтрации Car по атрибуту description сущности Repair можно написать следующее условие:

<filter id="carsFilter" datasource="carsDs">
    <custom name="repair"
            caption="msg://repair"
            paramClass="java.lang.String"
            join="join {E}.repairs cr">
        cr.description like ?
    </custom>
</filter>

При использовании такого условия исходный запрос источника данных:

select c from sample$Car c order by c.createTs

будет трансформирован в следующий:

select c from sample$Car c join c.repairs cr
where (cr.description like ?)
order by c.createTs

paramWhere − задает выражение на JPQL для отбора списка значений параметра условия, если параметр является связанной сущностью. См. описание одноименного атрибута элемента property.

paramView − задает представление, с которым будет загружаться список значений параметра условия, если параметр является связанной сущностью. Например, _local. Если не указано, используется _minimal.