One field that a user can filter on in the visual query builder UI. Maps a search index field to the query builder's simplified type system (string or integer) and to the set of comparison operators that make sense for that type, for example "contains" for strings or "between" for numbers.
Properties
| Property | Returns | Description |
|---|---|---|
| id | String | The search index field name this filter applies to. |
| indexType | String | The underlying search index mapping type for this field, for example "text" or "long", before it was simplified into getType. |
| label | String | The human readable label shown for this field in the query builder UI. |
| operators | List<String> | The comparison operators offered for this field in the query builder UI, chosen based on its type. |
| type | String | The query builder's simplified data type for this field, "string" or "integer", used to decide which operators and input controls apply. |
Methods
getId()
Returns: String
The search index field name this filter applies to.
getLabel()
Returns: String
The human readable label shown for this field in the query builder UI.
getType()
Returns: String
The query builder's simplified data type for this field, "string" or "integer", used to decide which operators and input controls apply.
getOperators()
Returns: List<String>
The comparison operators offered for this field in the query builder UI, chosen based on its type.
getIndexType()
Returns: String
The underlying search index mapping type for this field, for example "text" or "long", before it was simplified into getType.