query_docid.go

//  Copyright (c) 2015 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 bleve

import (
	"github.com/blevesearch/bleve/index"
	"github.com/blevesearch/bleve/search"
	"github.com/blevesearch/bleve/search/searchers"
)

type docIDQuery struct {
	IDs      []string `json:"ids"`
	BoostVal float64  `json:"boost,omitempty"`
}

// NewDocIDQuery creates a new Query object returning indexed documents among
// the specified set. Combine it with ConjunctionQuery to restrict the scope of
// other queries output.
func NewDocIDQuery(ids []string) *docIDQuery {
	return &docIDQuery{
		IDs:      ids,
		BoostVal: 1.0,
	}
}

func (q *docIDQuery) Boost() float64 {
	return q.BoostVal
}

func (q *docIDQuery) SetBoost(b float64) Query {
	q.BoostVal = b
	return q
}

func (q *docIDQuery) Field() string {
	return ""
}

func (q *docIDQuery) SetField(f string) Query {
	return q
}

func (q *docIDQuery) Searcher(i index.IndexReader, m *IndexMapping, explain bool) (search.Searcher, error) {
	return searchers.NewDocIDSearcher(i, q.IDs, q.BoostVal, explain)
}

func (q *docIDQuery) Validate() error {
	return nil
}