123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150 |
- // Copyright (c) 2014 Couchbase, Inc.
- //
- // Licensed under the Apache License, Version 2.0 (the "License");
- // you may not use this file except in compliance with the License.
- // You may obtain a copy of the License at
- //
- // http://www.apache.org/licenses/LICENSE-2.0
- //
- // Unless required by applicable law or agreed to in writing, software
- // distributed under the License is distributed on an "AS IS" BASIS,
- // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- // See the License for the specific language governing permissions and
- // limitations under the License.
-
- package search
-
- import (
- "fmt"
-
- "github.com/blevesearch/bleve/document"
- "github.com/blevesearch/bleve/index"
- )
-
- type ArrayPositions []uint64
-
- func (ap ArrayPositions) Equals(other ArrayPositions) bool {
- if len(ap) != len(other) {
- return false
- }
- for i := range ap {
- if ap[i] != other[i] {
- return false
- }
- }
- return true
- }
-
- type Location struct {
- // Pos is the position of the term within the field, starting at 1
- Pos uint64 `json:"pos"`
-
- // Start and End are the byte offsets of the term in the field
- Start uint64 `json:"start"`
- End uint64 `json:"end"`
-
- // ArrayPositions contains the positions of the term within any elements.
- ArrayPositions ArrayPositions `json:"array_positions"`
- }
-
- type Locations []*Location
-
- type TermLocationMap map[string]Locations
-
- func (t TermLocationMap) AddLocation(term string, location *Location) {
- t[term] = append(t[term], location)
- }
-
- type FieldTermLocationMap map[string]TermLocationMap
-
- type FieldFragmentMap map[string][]string
-
- type DocumentMatch struct {
- Index string `json:"index,omitempty"`
- ID string `json:"id"`
- IndexInternalID index.IndexInternalID `json:"-"`
- Score float64 `json:"score"`
- Expl *Explanation `json:"explanation,omitempty"`
- Locations FieldTermLocationMap `json:"locations,omitempty"`
- Fragments FieldFragmentMap `json:"fragments,omitempty"`
- Sort []string `json:"sort,omitempty"`
-
- // Fields contains the values for document fields listed in
- // SearchRequest.Fields. Text fields are returned as strings, numeric
- // fields as float64s and date fields as time.RFC3339 formatted strings.
- Fields map[string]interface{} `json:"fields,omitempty"`
-
- // if we load the document for this hit, remember it so we dont load again
- Document *document.Document `json:"-"`
-
- // used to maintain natural index order
- HitNumber uint64 `json:"-"`
- }
-
- func (dm *DocumentMatch) AddFieldValue(name string, value interface{}) {
- if dm.Fields == nil {
- dm.Fields = make(map[string]interface{})
- }
- existingVal, ok := dm.Fields[name]
- if !ok {
- dm.Fields[name] = value
- return
- }
-
- valSlice, ok := existingVal.([]interface{})
- if ok {
- // already a slice, append to it
- valSlice = append(valSlice, value)
- } else {
- // create a slice
- valSlice = []interface{}{existingVal, value}
- }
- dm.Fields[name] = valSlice
- }
-
- // Reset allows an already allocated DocumentMatch to be reused
- func (dm *DocumentMatch) Reset() *DocumentMatch {
- // remember the []byte used for the IndexInternalID
- indexInternalID := dm.IndexInternalID
- // remember the []interface{} used for sort
- sort := dm.Sort
- // idiom to copy over from empty DocumentMatch (0 allocations)
- *dm = DocumentMatch{}
- // reuse the []byte already allocated (and reset len to 0)
- dm.IndexInternalID = indexInternalID[:0]
- // reuse the []interface{} already allocated (and reset len to 0)
- dm.Sort = sort[:0]
- return dm
- }
-
- func (dm *DocumentMatch) String() string {
- return fmt.Sprintf("[%s-%f]", string(dm.IndexInternalID), dm.Score)
- }
-
- type DocumentMatchCollection []*DocumentMatch
-
- func (c DocumentMatchCollection) Len() int { return len(c) }
- func (c DocumentMatchCollection) Swap(i, j int) { c[i], c[j] = c[j], c[i] }
- func (c DocumentMatchCollection) Less(i, j int) bool { return c[i].Score > c[j].Score }
-
- type Searcher interface {
- Next(ctx *SearchContext) (*DocumentMatch, error)
- Advance(ctx *SearchContext, ID index.IndexInternalID) (*DocumentMatch, error)
- Close() error
- Weight() float64
- SetQueryNorm(float64)
- Count() uint64
- Min() int
-
- DocumentMatchPoolSize() int
- }
-
- type SearcherOptions struct {
- Explain bool
- IncludeTermVectors bool
- }
-
- // SearchContext represents the context around a single search
- type SearchContext struct {
- DocumentMatchPool *DocumentMatchPool
- }
|