40 lines
1.5 KiB
Go
40 lines
1.5 KiB
Go
|
// 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 document
|
||
|
|
|
||
|
|
import (
|
||
|
|
"github.com/blevesearch/bleve/analysis"
|
||
|
|
)
|
||
|
|
|
||
|
|
type Field interface {
|
||
|
|
// Name returns the path of the field from the root DocumentMapping.
|
||
|
|
// A root field path is "field", a subdocument field is "parent.field".
|
||
|
|
Name() string
|
||
|
|
// ArrayPositions returns the intermediate document and field indices
|
||
|
|
// required to resolve the field value in the document. For example, if the
|
||
|
|
// field path is "doc1.doc2.field" where doc1 and doc2 are slices or
|
||
|
|
// arrays, ArrayPositions returns 2 indices used to resolve "doc2" value in
|
||
|
|
// "doc1", then "field" in "doc2".
|
||
|
|
ArrayPositions() []uint64
|
||
|
|
Options() IndexingOptions
|
||
|
|
Analyze() (int, analysis.TokenFrequencies)
|
||
|
|
Value() []byte
|
||
|
|
|
||
|
|
// NumPlainTextBytes should return the number of plain text bytes
|
||
|
|
// that this field represents - this is a common metric for tracking
|
||
|
|
// the rate of indexing
|
||
|
|
NumPlainTextBytes() uint64
|
||
|
|
}
|