To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Field metadata for a value that is a foreign key into another AppIndexer's index - typically an entity ID - so its raw indexed value can be resolved to that related entity's display name instead of being shown as a bare number.
Extends: ESFieldMeta
Properties
| Property | Returns | Description |
|---|---|---|
| relatedAppIndexer | AppIndexer | AppIndexer that owns the index this field is related to. |
| relationField | String | Name of the field in the related index that this field's value matches against. |
Inherited from ESFieldMeta
Properties
| Property | Returns | Description |
|---|---|---|
| deprecated | boolean | Whether this field is deprecated and so hidden from the search UI while remaining indexed and queryable. |
| description | String | Description of what this field represents, as set on its builder. |
| idField | boolean | Whether this field is a relational identifier for its table or entity type. |
| name | String | Name of this field as it appears in the Elasticsearch mapping. |
| numericType | boolean | Whether this field's type is one of the numeric Elasticsearch types (long, double or integer). |
| subfield | ESFieldMeta | Metadata for this field's sub-field, if one was configured. |
| title | String | Display title for this field, resolved from the field name if none was explicitly set. |
| type | String | Elasticsearch type of this field, for example text, keyword, long or date. |
Methods
getDescription()
Returns: String
Description of what this field represents, as set on its builder.
getName()
Returns: String
Name of this field as it appears in the Elasticsearch mapping.
getTitle()
Returns: String
Display title for this field, resolved from the field name if none was explicitly set.
getType()
Returns: String
Elasticsearch type of this field, for example text, keyword, long or date.
getSubfield()
Returns: ESFieldMeta
Metadata for this field's sub-field, if one was configured.
isIdField()
Returns: boolean
Whether this field is a relational identifier for its table or entity type.
isDeprecated()
Returns: boolean
Whether this field is deprecated and so hidden from the search UI while remaining indexed and queryable.
isNumericType()
Returns: boolean
Whether this field's type is one of the numeric Elasticsearch types (long, double or integer).
Methods
getRelationField()
Returns: String
Name of the field in the related index that this field's value matches against.
getRelatedAppIndexer()
Returns: AppIndexer
AppIndexer that owns the index this field is related to.
formattedValues(Object rawValue)
Returns: RenderValue
Formats a raw indexed value by looking up its display name in the related AppIndexer's index, falling back to the default numeric/string formatting if no relation is configured.
| Parameter | Description |
|---|---|
rawValue | the raw value read back from Elasticsearch for this field |
© 2025 Kademi Ltd