File: search_facets_geo_distance.go

package info (click to toggle)
golang-gopkg-olivere-elastic.v2 2.0.12-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, buster, forky, sid, trixie
  • size: 1,964 kB
  • sloc: makefile: 17
file content (202 lines) | stat: -rw-r--r-- 4,766 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
// Copyright 2012-2015 Oliver Eilhard. All rights reserved.
// Use of this source code is governed by a MIT-license.
// See http://olivere.mit-license.org/license.txt for details.

package elastic

// The geo_distance facet is a facet providing information for ranges of
// distances from a provided geo_point including count of the number of hits
// that fall within each range, and aggregation information (like total).
// See: http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-facets-geo-distance-facet.html
type GeoDistanceFacet struct {
	facetFilter    Filter
	global         *bool
	nested         string
	mode           string
	fieldName      string
	valueFieldName string
	lat            float64
	lon            float64
	geoHash        string
	geoDistance    string
	unit           string
	params         map[string]interface{}
	valueScript    string
	lang           string
	entries        []geoDistanceFacetEntry
}

func NewGeoDistanceFacet() GeoDistanceFacet {
	return GeoDistanceFacet{
		params:  make(map[string]interface{}),
		entries: make([]geoDistanceFacetEntry, 0),
	}
}

func (f GeoDistanceFacet) FacetFilter(filter Facet) GeoDistanceFacet {
	f.facetFilter = filter
	return f
}

func (f GeoDistanceFacet) Global(global bool) GeoDistanceFacet {
	f.global = &global
	return f
}

func (f GeoDistanceFacet) Nested(nested string) GeoDistanceFacet {
	f.nested = nested
	return f
}

func (f GeoDistanceFacet) Mode(mode string) GeoDistanceFacet {
	f.mode = mode
	return f
}

func (f GeoDistanceFacet) Field(fieldName string) GeoDistanceFacet {
	f.fieldName = fieldName
	return f
}

func (f GeoDistanceFacet) ValueField(valueFieldName string) GeoDistanceFacet {
	f.valueFieldName = valueFieldName
	return f
}

func (f GeoDistanceFacet) ValueScript(valueScript string) GeoDistanceFacet {
	f.valueScript = valueScript
	return f
}

func (f GeoDistanceFacet) Lang(lang string) GeoDistanceFacet {
	f.lang = lang
	return f
}

func (f GeoDistanceFacet) ScriptParam(name string, value interface{}) GeoDistanceFacet {
	f.params[name] = value
	return f
}

func (f GeoDistanceFacet) Point(lat, lon float64) GeoDistanceFacet {
	f.lat = lat
	f.lon = lon
	return f
}

func (f GeoDistanceFacet) Lat(lat float64) GeoDistanceFacet {
	f.lat = lat
	return f
}

func (f GeoDistanceFacet) Lon(lon float64) GeoDistanceFacet {
	f.lon = lon
	return f
}

func (f GeoDistanceFacet) GeoHash(geoHash string) GeoDistanceFacet {
	f.geoHash = geoHash
	return f
}

func (f GeoDistanceFacet) GeoDistance(geoDistance string) GeoDistanceFacet {
	f.geoDistance = geoDistance
	return f
}

func (f GeoDistanceFacet) AddRange(from, to float64) GeoDistanceFacet {
	f.entries = append(f.entries, geoDistanceFacetEntry{From: from, To: to})
	return f
}

func (f GeoDistanceFacet) AddUnboundedTo(from float64) GeoDistanceFacet {
	f.entries = append(f.entries, geoDistanceFacetEntry{From: from, To: nil})
	return f
}

func (f GeoDistanceFacet) AddUnboundedFrom(to float64) GeoDistanceFacet {
	f.entries = append(f.entries, geoDistanceFacetEntry{From: nil, To: to})
	return f
}

func (f GeoDistanceFacet) Unit(distanceUnit string) GeoDistanceFacet {
	f.unit = distanceUnit
	return f
}

func (f GeoDistanceFacet) addFilterFacetAndGlobal(source map[string]interface{}) {
	if f.facetFilter != nil {
		source["facet_filter"] = f.facetFilter.Source()
	}
	if f.nested != "" {
		source["nested"] = f.nested
	}
	if f.global != nil {
		source["global"] = *f.global
	}
	if f.mode != "" {
		source["mode"] = f.mode
	}
}

func (f GeoDistanceFacet) Source() interface{} {
	source := make(map[string]interface{})
	f.addFilterFacetAndGlobal(source)
	opts := make(map[string]interface{})
	source["geo_distance"] = opts

	if f.geoHash != "" {
		opts[f.fieldName] = f.geoHash
	} else {
		opts[f.fieldName] = []float64{f.lat, f.lon}
	}
	if f.valueFieldName != "" {
		opts["value_field"] = f.valueFieldName
	}
	if f.valueScript != "" {
		opts["value_script"] = f.valueScript
		if f.lang != "" {
			opts["lang"] = f.lang
		}
		if len(f.params) > 0 {
			opts["params"] = f.params
		}
	}

	ranges := make([]interface{}, 0)
	for _, ent := range f.entries {
		r := make(map[string]interface{})
		if ent.From != nil {
			switch from := ent.From.(type) {
			case int, int16, int32, int64, float32, float64:
				r["from"] = from
			case string:
				r["from"] = from
			}
		}
		if ent.To != nil {
			switch to := ent.To.(type) {
			case int, int16, int32, int64, float32, float64:
				r["to"] = to
			case string:
				r["to"] = to
			}
		}
		ranges = append(ranges, r)
	}
	opts["ranges"] = ranges

	if f.unit != "" {
		opts["unit"] = f.unit
	}
	if f.geoDistance != "" {
		opts["distance_type"] = f.geoDistance
	}

	return source
}

type geoDistanceFacetEntry struct {
	From interface{}
	To   interface{}
}