| 1 |
// Copyright 2012-present Oliver Eilhard. All rights reserved. |
| 2 |
// Use of this source code is governed by a MIT-license. |
| 3 |
// See http://olivere.mit-license.org/license.txt for details. |
| 4 |
|
| 5 |
package elastic |
| 6 |
|
| 7 |
// Highlight allows highlighting search results on one or more fields. |
| 8 |
// For details, see: |
| 9 |
// https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-request-highlighting.html |
| 10 |
type Highlight struct { |
| 11 |
fields []*HighlighterField |
| 12 |
tagsSchema *string |
| 13 |
highlightFilter *bool |
| 14 |
fragmentSize *int |
| 15 |
numOfFragments *int |
| 16 |
preTags []string |
| 17 |
postTags []string |
| 18 |
order *string |
| 19 |
encoder *string |
| 20 |
requireFieldMatch *bool |
| 21 |
boundaryMaxScan *int |
| 22 |
boundaryChars *string |
| 23 |
boundaryScannerType *string |
| 24 |
boundaryScannerLocale *string |
| 25 |
highlighterType *string |
| 26 |
fragmenter *string |
| 27 |
highlightQuery Query |
| 28 |
noMatchSize *int |
| 29 |
phraseLimit *int |
| 30 |
options map[string]interface{} |
| 31 |
forceSource *bool |
| 32 |
useExplicitFieldOrder bool |
| 33 |
} |
| 34 |
|
| 35 |
func NewHighlight() *Highlight { |
| 36 |
hl := &Highlight{ |
| 37 |
options: make(map[string]interface{}), |
| 38 |
} |
| 39 |
return hl |
| 40 |
} |
| 41 |
|
| 42 |
func (hl *Highlight) Fields(fields ...*HighlighterField) *Highlight { |
| 43 |
hl.fields = append(hl.fields, fields...) |
| 44 |
return hl |
| 45 |
} |
| 46 |
|
| 47 |
func (hl *Highlight) Field(name string) *Highlight { |
| 48 |
field := NewHighlighterField(name) |
| 49 |
hl.fields = append(hl.fields, field) |
| 50 |
return hl |
| 51 |
} |
| 52 |
|
| 53 |
func (hl *Highlight) TagsSchema(schemaName string) *Highlight { |
| 54 |
hl.tagsSchema = &schemaName |
| 55 |
return hl |
| 56 |
} |
| 57 |
|
| 58 |
func (hl *Highlight) HighlightFilter(highlightFilter bool) *Highlight { |
| 59 |
hl.highlightFilter = &highlightFilter |
| 60 |
return hl |
| 61 |
} |
| 62 |
|
| 63 |
func (hl *Highlight) FragmentSize(fragmentSize int) *Highlight { |
| 64 |
hl.fragmentSize = &fragmentSize |
| 65 |
return hl |
| 66 |
} |
| 67 |
|
| 68 |
func (hl *Highlight) NumOfFragments(numOfFragments int) *Highlight { |
| 69 |
hl.numOfFragments = &numOfFragments |
| 70 |
return hl |
| 71 |
} |
| 72 |
|
| 73 |
func (hl *Highlight) Encoder(encoder string) *Highlight { |
| 74 |
hl.encoder = &encoder |
| 75 |
return hl |
| 76 |
} |
| 77 |
|
| 78 |
func (hl *Highlight) PreTags(preTags ...string) *Highlight { |
| 79 |
hl.preTags = append(hl.preTags, preTags...) |
| 80 |
return hl |
| 81 |
} |
| 82 |
|
| 83 |
func (hl *Highlight) PostTags(postTags ...string) *Highlight { |
| 84 |
hl.postTags = append(hl.postTags, postTags...) |
| 85 |
return hl |
| 86 |
} |
| 87 |
|
| 88 |
func (hl *Highlight) Order(order string) *Highlight { |
| 89 |
hl.order = &order |
| 90 |
return hl |
| 91 |
} |
| 92 |
|
| 93 |
func (hl *Highlight) RequireFieldMatch(requireFieldMatch bool) *Highlight { |
| 94 |
hl.requireFieldMatch = &requireFieldMatch |
| 95 |
return hl |
| 96 |
} |
| 97 |
|
| 98 |
func (hl *Highlight) BoundaryMaxScan(boundaryMaxScan int) *Highlight { |
| 99 |
hl.boundaryMaxScan = &boundaryMaxScan |
| 100 |
return hl |
| 101 |
} |
| 102 |
|
| 103 |
func (hl *Highlight) BoundaryChars(boundaryChars string) *Highlight { |
| 104 |
hl.boundaryChars = &boundaryChars |
| 105 |
return hl |
| 106 |
} |
| 107 |
|
| 108 |
func (hl *Highlight) BoundaryScannerType(boundaryScannerType string) *Highlight { |
| 109 |
hl.boundaryScannerType = &boundaryScannerType |
| 110 |
return hl |
| 111 |
} |
| 112 |
|
| 113 |
func (hl *Highlight) BoundaryScannerLocale(boundaryScannerLocale string) *Highlight { |
| 114 |
hl.boundaryScannerLocale = &boundaryScannerLocale |
| 115 |
return hl |
| 116 |
} |
| 117 |
|
| 118 |
func (hl *Highlight) HighlighterType(highlighterType string) *Highlight { |
| 119 |
hl.highlighterType = &highlighterType |
| 120 |
return hl |
| 121 |
} |
| 122 |
|
| 123 |
func (hl *Highlight) Fragmenter(fragmenter string) *Highlight { |
| 124 |
hl.fragmenter = &fragmenter |
| 125 |
return hl |
| 126 |
} |
| 127 |
|
| 128 |
func (hl *Highlight) HighlightQuery(highlightQuery Query) *Highlight { |
| 129 |
hl.highlightQuery = highlightQuery |
| 130 |
return hl |
| 131 |
} |
| 132 |
|
| 133 |
func (hl *Highlight) NoMatchSize(noMatchSize int) *Highlight { |
| 134 |
hl.noMatchSize = &noMatchSize |
| 135 |
return hl |
| 136 |
} |
| 137 |
|
| 138 |
func (hl *Highlight) Options(options map[string]interface{}) *Highlight { |
| 139 |
hl.options = options |
| 140 |
return hl |
| 141 |
} |
| 142 |
|
| 143 |
func (hl *Highlight) ForceSource(forceSource bool) *Highlight { |
| 144 |
hl.forceSource = &forceSource |
| 145 |
return hl |
| 146 |
} |
| 147 |
|
| 148 |
func (hl *Highlight) UseExplicitFieldOrder(useExplicitFieldOrder bool) *Highlight { |
| 149 |
hl.useExplicitFieldOrder = useExplicitFieldOrder |
| 150 |
return hl |
| 151 |
} |
| 152 |
|
| 153 |
// Creates the query source for the bool query. |
| 154 |
func (hl *Highlight) Source() (interface{}, error) { |
| 155 |
// Returns the map inside of "highlight": |
| 156 |
// "highlight":{ |
| 157 |
// ... this ... |
| 158 |
// } |
| 159 |
source := make(map[string]interface{}) |
| 160 |
if hl.tagsSchema != nil { |
| 161 |
source["tags_schema"] = *hl.tagsSchema |
| 162 |
} |
| 163 |
if hl.preTags != nil && len(hl.preTags) > 0 { |
| 164 |
source["pre_tags"] = hl.preTags |
| 165 |
} |
| 166 |
if hl.postTags != nil && len(hl.postTags) > 0 { |
| 167 |
source["post_tags"] = hl.postTags |
| 168 |
} |
| 169 |
if hl.order != nil { |
| 170 |
source["order"] = *hl.order |
| 171 |
} |
| 172 |
if hl.highlightFilter != nil { |
| 173 |
source["highlight_filter"] = *hl.highlightFilter |
| 174 |
} |
| 175 |
if hl.fragmentSize != nil { |
| 176 |
source["fragment_size"] = *hl.fragmentSize |
| 177 |
} |
| 178 |
if hl.numOfFragments != nil { |
| 179 |
source["number_of_fragments"] = *hl.numOfFragments |
| 180 |
} |
| 181 |
if hl.encoder != nil { |
| 182 |
source["encoder"] = *hl.encoder |
| 183 |
} |
| 184 |
if hl.requireFieldMatch != nil { |
| 185 |
source["require_field_match"] = *hl.requireFieldMatch |
| 186 |
} |
| 187 |
if hl.boundaryMaxScan != nil { |
| 188 |
source["boundary_max_scan"] = *hl.boundaryMaxScan |
| 189 |
} |
| 190 |
if hl.boundaryChars != nil { |
| 191 |
source["boundary_chars"] = *hl.boundaryChars |
| 192 |
} |
| 193 |
if hl.boundaryScannerType != nil { |
| 194 |
source["boundary_scanner"] = *hl.boundaryScannerType |
| 195 |
} |
| 196 |
if hl.boundaryScannerLocale != nil { |
| 197 |
source["boundary_scanner_locale"] = *hl.boundaryScannerLocale |
| 198 |
} |
| 199 |
if hl.highlighterType != nil { |
| 200 |
source["type"] = *hl.highlighterType |
| 201 |
} |
| 202 |
if hl.fragmenter != nil { |
| 203 |
source["fragmenter"] = *hl.fragmenter |
| 204 |
} |
| 205 |
if hl.highlightQuery != nil { |
| 206 |
src, err := hl.highlightQuery.Source() |
| 207 |
if err != nil { |
| 208 |
return nil, err |
| 209 |
} |
| 210 |
source["highlight_query"] = src |
| 211 |
} |
| 212 |
if hl.noMatchSize != nil { |
| 213 |
source["no_match_size"] = *hl.noMatchSize |
| 214 |
} |
| 215 |
if hl.phraseLimit != nil { |
| 216 |
source["phrase_limit"] = *hl.phraseLimit |
| 217 |
} |
| 218 |
if hl.options != nil && len(hl.options) > 0 { |
| 219 |
source["options"] = hl.options |
| 220 |
} |
| 221 |
if hl.forceSource != nil { |
| 222 |
source["force_source"] = *hl.forceSource |
| 223 |
} |
| 224 |
|
| 225 |
if hl.fields != nil && len(hl.fields) > 0 { |
| 226 |
if hl.useExplicitFieldOrder { |
| 227 |
// Use a slice for the fields |
| 228 |
var fields []map[string]interface{} |
| 229 |
for _, field := range hl.fields { |
| 230 |
src, err := field.Source() |
| 231 |
if err != nil { |
| 232 |
return nil, err |
| 233 |
} |
| 234 |
fmap := make(map[string]interface{}) |
| 235 |
fmap[field.Name] = src |
| 236 |
fields = append(fields, fmap) |
| 237 |
} |
| 238 |
source["fields"] = fields |
| 239 |
} else { |
| 240 |
// Use a map for the fields |
| 241 |
fields := make(map[string]interface{}, 0) |
| 242 |
for _, field := range hl.fields { |
| 243 |
src, err := field.Source() |
| 244 |
if err != nil { |
| 245 |
return nil, err |
| 246 |
} |
| 247 |
fields[field.Name] = src |
| 248 |
} |
| 249 |
source["fields"] = fields |
| 250 |
} |
| 251 |
} |
| 252 |
|
| 253 |
return source, nil |
| 254 |
} |
| 255 |
|
| 256 |
// HighlighterField specifies a highlighted field. |
| 257 |
type HighlighterField struct { |
| 258 |
Name string |
| 259 |
|
| 260 |
preTags []string |
| 261 |
postTags []string |
| 262 |
fragmentSize int |
| 263 |
fragmentOffset int |
| 264 |
numOfFragments int |
| 265 |
highlightFilter *bool |
| 266 |
order *string |
| 267 |
requireFieldMatch *bool |
| 268 |
boundaryMaxScan int |
| 269 |
boundaryChars []rune |
| 270 |
highlighterType *string |
| 271 |
fragmenter *string |
| 272 |
highlightQuery Query |
| 273 |
noMatchSize *int |
| 274 |
matchedFields []string |
| 275 |
phraseLimit *int |
| 276 |
options map[string]interface{} |
| 277 |
forceSource *bool |
| 278 |
|
| 279 |
/* |
| 280 |
Name string |
| 281 |
preTags []string |
| 282 |
postTags []string |
| 283 |
fragmentSize int |
| 284 |
numOfFragments int |
| 285 |
fragmentOffset int |
| 286 |
highlightFilter *bool |
| 287 |
order string |
| 288 |
requireFieldMatch *bool |
| 289 |
boundaryMaxScan int |
| 290 |
boundaryChars []rune |
| 291 |
highlighterType string |
| 292 |
fragmenter string |
| 293 |
highlightQuery Query |
| 294 |
noMatchSize *int |
| 295 |
matchedFields []string |
| 296 |
options map[string]interface{} |
| 297 |
forceSource *bool |
| 298 |
*/ |
| 299 |
} |
| 300 |
|
| 301 |
func NewHighlighterField(name string) *HighlighterField { |
| 302 |
return &HighlighterField{ |
| 303 |
Name: name, |
| 304 |
preTags: make([]string, 0), |
| 305 |
postTags: make([]string, 0), |
| 306 |
fragmentSize: -1, |
| 307 |
fragmentOffset: -1, |
| 308 |
numOfFragments: -1, |
| 309 |
boundaryMaxScan: -1, |
| 310 |
boundaryChars: make([]rune, 0), |
| 311 |
matchedFields: make([]string, 0), |
| 312 |
options: make(map[string]interface{}), |
| 313 |
} |
| 314 |
} |
| 315 |
|
| 316 |
func (f *HighlighterField) PreTags(preTags ...string) *HighlighterField { |
| 317 |
f.preTags = append(f.preTags, preTags...) |
| 318 |
return f |
| 319 |
} |
| 320 |
|
| 321 |
func (f *HighlighterField) PostTags(postTags ...string) *HighlighterField { |
| 322 |
f.postTags = append(f.postTags, postTags...) |
| 323 |
return f |
| 324 |
} |
| 325 |
|
| 326 |
func (f *HighlighterField) FragmentSize(fragmentSize int) *HighlighterField { |
| 327 |
f.fragmentSize = fragmentSize |
| 328 |
return f |
| 329 |
} |
| 330 |
|
| 331 |
func (f *HighlighterField) FragmentOffset(fragmentOffset int) *HighlighterField { |
| 332 |
f.fragmentOffset = fragmentOffset |
| 333 |
return f |
| 334 |
} |
| 335 |
|
| 336 |
func (f *HighlighterField) NumOfFragments(numOfFragments int) *HighlighterField { |
| 337 |
f.numOfFragments = numOfFragments |
| 338 |
return f |
| 339 |
} |
| 340 |
|
| 341 |
func (f *HighlighterField) HighlightFilter(highlightFilter bool) *HighlighterField { |
| 342 |
f.highlightFilter = &highlightFilter |
| 343 |
return f |
| 344 |
} |
| 345 |
|
| 346 |
func (f *HighlighterField) Order(order string) *HighlighterField { |
| 347 |
f.order = &order |
| 348 |
return f |
| 349 |
} |
| 350 |
|
| 351 |
func (f *HighlighterField) RequireFieldMatch(requireFieldMatch bool) *HighlighterField { |
| 352 |
f.requireFieldMatch = &requireFieldMatch |
| 353 |
return f |
| 354 |
} |
| 355 |
|
| 356 |
func (f *HighlighterField) BoundaryMaxScan(boundaryMaxScan int) *HighlighterField { |
| 357 |
f.boundaryMaxScan = boundaryMaxScan |
| 358 |
return f |
| 359 |
} |
| 360 |
|
| 361 |
func (f *HighlighterField) BoundaryChars(boundaryChars ...rune) *HighlighterField { |
| 362 |
f.boundaryChars = append(f.boundaryChars, boundaryChars...) |
| 363 |
return f |
| 364 |
} |
| 365 |
|
| 366 |
func (f *HighlighterField) HighlighterType(highlighterType string) *HighlighterField { |
| 367 |
f.highlighterType = &highlighterType |
| 368 |
return f |
| 369 |
} |
| 370 |
|
| 371 |
func (f *HighlighterField) Fragmenter(fragmenter string) *HighlighterField { |
| 372 |
f.fragmenter = &fragmenter |
| 373 |
return f |
| 374 |
} |
| 375 |
|
| 376 |
func (f *HighlighterField) HighlightQuery(highlightQuery Query) *HighlighterField { |
| 377 |
f.highlightQuery = highlightQuery |
| 378 |
return f |
| 379 |
} |
| 380 |
|
| 381 |
func (f *HighlighterField) NoMatchSize(noMatchSize int) *HighlighterField { |
| 382 |
f.noMatchSize = &noMatchSize |
| 383 |
return f |
| 384 |
} |
| 385 |
|
| 386 |
func (f *HighlighterField) Options(options map[string]interface{}) *HighlighterField { |
| 387 |
f.options = options |
| 388 |
return f |
| 389 |
} |
| 390 |
|
| 391 |
func (f *HighlighterField) MatchedFields(matchedFields ...string) *HighlighterField { |
| 392 |
f.matchedFields = append(f.matchedFields, matchedFields...) |
| 393 |
return f |
| 394 |
} |
| 395 |
|
| 396 |
func (f *HighlighterField) PhraseLimit(phraseLimit int) *HighlighterField { |
| 397 |
f.phraseLimit = &phraseLimit |
| 398 |
return f |
| 399 |
} |
| 400 |
|
| 401 |
func (f *HighlighterField) ForceSource(forceSource bool) *HighlighterField { |
| 402 |
f.forceSource = &forceSource |
| 403 |
return f |
| 404 |
} |
| 405 |
|
| 406 |
func (f *HighlighterField) Source() (interface{}, error) { |
| 407 |
source := make(map[string]interface{}) |
| 408 |
|
| 409 |
if f.preTags != nil && len(f.preTags) > 0 { |
| 410 |
source["pre_tags"] = f.preTags |
| 411 |
} |
| 412 |
if f.postTags != nil && len(f.postTags) > 0 { |
| 413 |
source["post_tags"] = f.postTags |
| 414 |
} |
| 415 |
if f.fragmentSize != -1 { |
| 416 |
source["fragment_size"] = f.fragmentSize |
| 417 |
} |
| 418 |
if f.numOfFragments != -1 { |
| 419 |
source["number_of_fragments"] = f.numOfFragments |
| 420 |
} |
| 421 |
if f.fragmentOffset != -1 { |
| 422 |
source["fragment_offset"] = f.fragmentOffset |
| 423 |
} |
| 424 |
if f.highlightFilter != nil { |
| 425 |
source["highlight_filter"] = *f.highlightFilter |
| 426 |
} |
| 427 |
if f.order != nil { |
| 428 |
source["order"] = *f.order |
| 429 |
} |
| 430 |
if f.requireFieldMatch != nil { |
| 431 |
source["require_field_match"] = *f.requireFieldMatch |
| 432 |
} |
| 433 |
if f.boundaryMaxScan != -1 { |
| 434 |
source["boundary_max_scan"] = f.boundaryMaxScan |
| 435 |
} |
| 436 |
if f.boundaryChars != nil && len(f.boundaryChars) > 0 { |
| 437 |
source["boundary_chars"] = f.boundaryChars |
| 438 |
} |
| 439 |
if f.highlighterType != nil { |
| 440 |
source["type"] = *f.highlighterType |
| 441 |
} |
| 442 |
if f.fragmenter != nil { |
| 443 |
source["fragmenter"] = *f.fragmenter |
| 444 |
} |
| 445 |
if f.highlightQuery != nil { |
| 446 |
src, err := f.highlightQuery.Source() |
| 447 |
if err != nil { |
| 448 |
return nil, err |
| 449 |
} |
| 450 |
source["highlight_query"] = src |
| 451 |
} |
| 452 |
if f.noMatchSize != nil { |
| 453 |
source["no_match_size"] = *f.noMatchSize |
| 454 |
} |
| 455 |
if f.matchedFields != nil && len(f.matchedFields) > 0 { |
| 456 |
source["matched_fields"] = f.matchedFields |
| 457 |
} |
| 458 |
if f.phraseLimit != nil { |
| 459 |
source["phrase_limit"] = *f.phraseLimit |
| 460 |
} |
| 461 |
if f.options != nil && len(f.options) > 0 { |
| 462 |
source["options"] = f.options |
| 463 |
} |
| 464 |
if f.forceSource != nil { |
| 465 |
source["force_source"] = *f.forceSource |
| 466 |
} |
| 467 |
|
| 468 |
return source, nil |
| 469 |
} |