Field metadata for a value resolved to a display label by calling a lookup function directly, rather than through a relation to another AppIndexer's index - used where the two indexes are not both searchable, or the same lookup is reused across several field definitions (see ESMappingsBuilder.FieldLookupFunctions).

Extends: ESFieldMeta


Inherited from ESFieldMeta

Properties

PropertyReturnsDescription
deprecatedbooleanWhether this field is deprecated and so hidden from the search UI while remaining indexed and queryable.
descriptionStringDescription of what this field represents, as set on its builder.
idFieldbooleanWhether this field is a relational identifier for its table or entity type.
nameStringName of this field as it appears in the Elasticsearch mapping.
numericTypebooleanWhether this field's type is one of the numeric Elasticsearch types (long, double or integer).
subfieldESFieldMetaMetadata for this field's sub-field, if one was configured.
titleStringDisplay title for this field, resolved from the field name if none was explicitly set.
typeStringElasticsearch 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

formattedValues(Object rawValue)

Returns: RenderValue

Formats a raw indexed value by passing it to the configured lookup function, falling back to the default string formatting if the function returns a blank result.

ParameterDescription
rawValuethe raw value read back from Elasticsearch for this field
To get full access to the Kademi Hub existing customers can login here, or new customers can register here.