f8d3d9f0cf
Some checks failed
Coverage / coverage (push) Failing after 6s
Tests / test (1.24.x, ubuntu-latest) (push) Failing after 42s
Tests / test (1.26.x, ubuntu-latest) (push) Failing after 38s
Tests / test (1.25.x, ubuntu-latest) (push) Failing after 35s
Tests / test (1.25.x, windows-latest) (push) Has been cancelled
Tests / test (1.26.x, macos-latest) (push) Has been cancelled
Tests / test (1.26.x, windows-latest) (push) Has been cancelled
Tests / test (1.24.x, macos-latest) (push) Has been cancelled
Tests / test (1.24.x, windows-latest) (push) Has been cancelled
Tests / test (1.25.x, macos-latest) (push) Has been cancelled
96 lines
3.0 KiB
Go
96 lines
3.0 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 mapping
|
|
|
|
import (
|
|
"io"
|
|
"log"
|
|
|
|
"github.com/blevesearch/bleve/v2/analysis"
|
|
"github.com/blevesearch/bleve/v2/document"
|
|
"github.com/blevesearch/bleve/v2/search"
|
|
)
|
|
|
|
// A Classifier is an interface describing any object which knows how to
|
|
// identify its own type. Alternatively, if a struct already has a Type
|
|
// field or method in conflict, one can use BleveType instead.
|
|
type Classifier interface {
|
|
Type() string
|
|
}
|
|
|
|
// A bleveClassifier is an interface describing any object which knows how
|
|
// to identify its own type. This is introduced as an alternative to the
|
|
// Classifier interface which often has naming conflicts with existing
|
|
// structures.
|
|
type bleveClassifier interface {
|
|
BleveType() string
|
|
}
|
|
|
|
var logger = log.New(io.Discard, "bleve mapping ", log.LstdFlags)
|
|
|
|
// SetLog sets the logger used for logging
|
|
// by default log messages are sent to io.Discard
|
|
func SetLog(l *log.Logger) {
|
|
logger = l
|
|
}
|
|
|
|
type IndexMapping interface {
|
|
MapDocument(doc *document.Document, data interface{}) error
|
|
Validate() error
|
|
|
|
DateTimeParserNamed(name string) analysis.DateTimeParser
|
|
|
|
DefaultSearchField() string
|
|
|
|
AnalyzerNameForPath(path string) string
|
|
AnalyzerNamed(name string) analysis.Analyzer
|
|
|
|
FieldMappingForPath(path string) FieldMapping
|
|
}
|
|
|
|
// A SynonymMapping extends the IndexMapping interface to provide
|
|
// additional methods for working with synonyms.
|
|
type SynonymMapping interface {
|
|
IndexMapping
|
|
|
|
MapSynonymDocument(doc *document.Document, collection string, input []string, synonyms []string) error
|
|
|
|
SynonymSourceForPath(path string) string
|
|
|
|
SynonymSourceNamed(name string) analysis.SynonymSource
|
|
|
|
SynonymCount() int
|
|
|
|
SynonymSourceVisitor(visitor analysis.SynonymSourceVisitor) error
|
|
}
|
|
|
|
// A NestedMapping extends the IndexMapping interface to provide
|
|
// additional methods for working with nested object mappings.
|
|
type NestedMapping interface {
|
|
// NestedDepth returns two values:
|
|
// - common: the highest nested level that is common to all given field paths,
|
|
// if 0 then there is no common nested level among the given field paths
|
|
// - max: the highest nested level that applies to at least one of the given field paths
|
|
// if 0 then none of the given field paths are nested
|
|
NestedDepth(fieldPaths search.FieldSet) (int, int)
|
|
|
|
// IntersectsPrefix returns true if any of the given
|
|
// field paths intersect with a known nested prefix
|
|
IntersectsPrefix(fieldPaths search.FieldSet) bool
|
|
|
|
// CountNested returns the number of nested object mappings
|
|
CountNested() int
|
|
}
|