Skip to main content

FilterExtensionSet

This page provides generated reference documentation for the FilterExtensionSet data model.

FilterExtensionSet is an ADITO model used for extending the standard filter by an additional filter option, partly similar to the FilterExtension, but more complex and powerful.

Overview​

PropertySummary
documentationContains the documentation of the data model in the popular AsciiDoc format (.adoc). The documentation should be set by the developer to explain different…
filterFieldsProcessThis process delivers a list of fields, which can be used to extend options for filtering or grouping. This process has to return an array of objects with the…
isFilterableBoolean flag for indicating, if this field is filterable
filterValuesProcessThis process delivers possible values for this field.
filterConditionProcessThis process delivers a condition, which will be used to obtain the recordset
isGroupableIf the groupable property of a field is set, this field can be selected as a grouping in the filter, but only if the RecordContainer is pageable. This is only…
groupQueryProcessThis process has to return a SQL query as string for obtaining the list of groups. Various $local variables are available to make this easier.
filtertypeDelivers a hint, to which filter this field(s) should be added
isLookupFilterDelivers a hint, if this filter is a lookup to an other context

documentation​

Type: String

Contains the documentation of the data model in the popular AsciiDoc format (.adoc). The documentation should be set by the developer to explain different aspects (like purpose, concept, etc.) of the data model that he designed.
You may want to add the plugin "AsciidoctorJ" to your ADITO Designer in order to modify AsciiDoc files.

filterFieldsProcess​

Type: String

This process delivers a list of fields, which can be used to extend options for filtering or grouping. This process has to return an array of objects with the following parameters:\

  • name: unique identifier\
  • title: (unique) title\
  • contentType: content type of the filter field, e.g. TEXT\
  • hasDropDownValues: if true uses the return values of the filterValueProcess as possible filter values\
  • isFilterable: if true the field is shown in the filter fields\
  • isGroupable: if true the field is shown in the groupable fields\
  • groupedRecordField: the corresponding record field in the database, e.g. ID_VALUE\
  • titleRecordField: expects a SQL statement which contains the grouping title. If this parameter is empty, the value of the groupedRecordField is used as title.\
  • consumer: expects the name of the consumer as string. If this parameter is set, instead of using the filterValuesProcess, the values returned by the consumer are used as possible filter values.

isFilterable​

Type: Boolean
Default: true

Boolean flag for indicating, if this field is filterable

filterValuesProcess​

Type: String

This process delivers possible values for this field.

Parameters​

$local.filter
  A JSON object with fields, operator and value

filterConditionProcess​

Type: String

This process delivers a condition, which will be used to obtain the recordset

Parameters​

$local.name
  The name of the component

$local.condition
  The Where condition

$local.conditionHaving
  The Having condition

$local.operator
  An SQL operator that can be read with the constant: "swing.OPERATOR_*"

$local.operator2
  Search operand, returns the operator directly, e.g. "<>", "="

$local.value
  The current value

$local.rawvalue
  The value as entered by the user, <tt>zero</tt> if operator has no value

$local.columntype
  The type of the defined column; Can be queried with SQLTYPES.*

$local.placeholder
  The constant for the placeholders. For search template as configured, for search table calculated from the search operator

$local.isAggregateCondition
  Bool that indicates whether an aggregate condition is contained

$local.columnPlaceholder
  The column placeholder for example for the handling of attributes in JDito

$local.selection
  The selection

isGroupable​

Type: Boolean

If the groupable property of a field is set, this field can be selected as a grouping in the filter, but only if the RecordContainer is pageable. This is only possible in views that support grouping - for example: Tree, TreeTable, Chart, Map.

groupQueryProcess​

Type: String

This process has to return a SQL query as string for obtaining the list of groups. Various $local variables are available to make this easier.\

  • $local.name: Contains the full name in the following format: entityName.fieldName\
  • $local.fieldname: Contains the fieldName\
  • $local.contenttype: Contains the type of the field, e.g. TEXT, NUMBER, IMAGE, BOOLEAN, ...\
  • $local.columntype: Contains the generic SQL type, e.g. VARCHAR, NUMERIC, BINARY, TIMESTAMP, ...\
  • $local.count: Contains a boolean which is true, if only the number of records is required. If this property is true the data can be ignored. Only the number of records must be correct.\
  • $local.columns: Contains the columns of a table which are required as string array.\
  • $local.columnlist: Contains the columns of a table which are required in a comma separated list. Can never be null, only empty list.\
  • $local.condition: Contains the where-clause of an SQL as string.\
  • $local.grouped: Contains the current grouping in form of an array.\
  • $local.groupedList: Contains the current grouping as comma separated list.\
  • $local.order: Contains the fields and the corresponding order as a map in the following format: e.g. "ATTRIBUTE_TYPE.displayValue" -> "UP"

filtertype​

Type: EFilterType

Delivers a hint, to which filter this field(s) should be added

isLookupFilter​

Type: Boolean

Delivers a hint, if this filter is a lookup to an other context