XML Configuration Reference : Datamodel : AlphanumProperty
 
AlphanumProperty
com.exalead.datamodel.v10.AlphanumProperty
Alphanumerical property.
Parent elements:
com.exalead.datamodel.v10.DataModelClass (as DataModelClass)
com.exalead.datamodel.v10.DynamicProperty (as DynamicProperty)
Attributes:
Name
Type
Default value
Description
overrideClassExpansionParams
boolean
dedicatedField
boolean
True
Should we create a dedicated index field for this property, or use a multi-field encoding? A dedicated field is recommended if more than a few percent of objects have this property. Internal: if there is no dedicated field, we store in the "metas" field and index using prefixed-words.
dynamicProperty
string
Storing this meta in a dynamical property decreases index's memory footprint and improve index's commit time. Faceting and sorting performances will be impacted (slower).
searchable
boolean
True
Allows users to search for matches in this property using a prefix. For example, to search for "API" in the title of a document, enter the search query <pre>title:API</pre>
retrievable
boolean
True
Displays the meta in the hit content of search results. If the property doesn't have a dedicated field, the value will be CSV-encoded in the 'metas' field.
ramBased
boolean
Stores this property in RAM. Use this option if you need to:
sort search results on this property.
use this property in a virtual field.
use this property in a virtual facet.
use this property for an aggregation value.
Only the "retrievable" part of the property is stored in RAM.
facet
boolean
Creates a navigation facet from the property values.
disjunctiveRefines
boolean
Makes refinements on this facet disjunctive ("checkboxes") rather than exclusive (select one).
defaultValue
string
If there is no value for this property in the document, use this default value.
additionalMetaNames
string
Maps these metas (as a comma-separated list) to this index or facet field. Usable only for properties having a dedicated field, a facet, or are searchable without prefix.
arity
enum(zero_or_one, one, many)
zero_or_one
The arity of the property (zero_or_one, one, many) {@code enum(zero_or_one, one, many)}
name
string
Property name
comment
string
Optional comment to explain property use.
semanticType
string
Defines how the text is processed and indexed (tokenization, normalization and indexing-time semantic processing). This value must refer to a valid !SemanticType object in the DataModel.
indexInTextField
boolean
Allows users to search for matches in this property without using a prefix, by mapping the values to the generic "text" index field, as invisible text. For example, to search for "API" in a document, enter the search query <pre>API</pre>
queryExpansionConfig
string
Search-time query expansion config to use for this property. This follows the 'QEC' format specification.
enumerated
boolean
Is there a controlled and limited set of values for this property? Enumerated properties are indexed using a specific "Value" field, which stores entire values in an optimized way. Thus, performing faceting on this kind of field is faster than on a category field. It is not possible to perform any semantic processing on value fields.
Nested elements:
Name
Type
Description
tags
exa.bee.KeyValue*
User-defined tags for this property. This can be used for example to implement 6W faceting of the data model.
AdvancedParams
com.exalead.datamodel.v10.AdvancedParams
KeyValue
exa.bee.KeyValue*
Label
com.exalead.datamodel.v10.Label*
Labels for the internationalization of this property's name