osmfeatures/de.westnordost.osmfeatures/BaseFeature

BaseFeature

data class BaseFeature(val id: String, val tags: Map<String, String>, val geometry: List<GeometryType>, val icon: String?, val imageURL: String?, val names: List<String>, val terms: List<String>, val includeCountryCodes: List<String>, val excludeCountryCodes: List<String>, val isSearchable: Boolean, val matchScore: Float, val isSuggestion: Boolean, val addTags: Map<String, String>, val removeTags: Map<String, String>, val preserveTags: List<Regex>) : Feature

Data class associated with the Feature interface. Represents a non-localized feature.

Constructors

constructor(id: String, tags: Map<String, String>, geometry: List<GeometryType>, icon: String?, imageURL: String?, names: List<String>, terms: List<String>, includeCountryCodes: List<String>, excludeCountryCodes: List<String>, isSearchable: Boolean, matchScore: Float, isSuggestion: Boolean, addTags: Map<String, String>, removeTags: Map<String, String>, preserveTags: List<Regex>)

Properties

open override val addTags: Map<String, String>

tags that are added when selecting this feature. This can differ from tags, as those are just the minimum tags necessary to match this feature

open override val canonicalNames: List<String>

primary names + aliases in all lowercase with stripped diacritics

open override val canonicalTerms: List<String>

Additional search terms or keywords in all lowercase with stripped diacritics

excludeCountryCodes

open override val excludeCountryCodes: List<String>

A list of ISO 3166-1 2 or 3 letter country codes country codes in which this feature is not available. Empty if it available everywhere.

open override val geometry: List<GeometryType>

a list of possible geometry types for this feature

open override val icon: String?

icon representing the feature

open override val id: String

unique identifier for this feature

open override val imageURL: String?

url to image representing the feature. Usually used for brands features

includeCountryCodes

open override val includeCountryCodes: List<String>

A list of ISO 3166-1 2 or 3 letter country codes country codes in which this feature is available. Empty if it is available everywhere.

open override val isSearchable: Boolean

Whether this feature should be searchable. E.g. deprecated or generic features are not searchable.

open override val isSuggestion: Boolean

Whether this feature is a brand feature i.e. from the NSI

open override val language: String?

ISO 639 language code of this feature. null if it isn't localized.

open override val matchScore: Float

A number that ranks this preset against others that match the feature.

open val name: String

primary name

open override val names: List<String>

primary name + aliases

open override val preserveTags: List<Regex>

Regexes for keys of tags which should not be overwritten by addTags when selecting a feature.

open override val removeTags: Map<String, String>

tags that are removed from the feature when deselecting this feature.

open override val tags: Map<String, String>

tags a feature must have to match this feature

open override val terms: List<String>

Additional search terms or keywords to find this feature

Functions

open override fun toString(): String