snapshot of https://github.com/blevesearch/bleve.git (master, 2026-09-15; blobs > 131072B omitted)

analysis/token/keyword/keyword.go

@@ -0,0 +1,63 @@
+//  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 keyword
+
+import (
+	"fmt"
+
+	"github.com/blevesearch/bleve/v2/analysis"
+	"github.com/blevesearch/bleve/v2/registry"
+)
+
+const Name = "keyword_marker"
+
+type KeyWordMarkerFilter struct {
+	keyWords analysis.TokenMap
+}
+
+func NewKeyWordMarkerFilter(keyWords analysis.TokenMap) *KeyWordMarkerFilter {
+	return &KeyWordMarkerFilter{
+		keyWords: keyWords,
+	}
+}
+
+func (f *KeyWordMarkerFilter) Filter(input analysis.TokenStream) analysis.TokenStream {
+	for _, token := range input {
+		_, isKeyWord := f.keyWords[string(token.Term)]
+		if isKeyWord {
+			token.KeyWord = true
+		}
+	}
+	return input
+}
+
+func KeyWordMarkerFilterConstructor(config map[string]interface{}, cache *registry.Cache) (analysis.TokenFilter, error) {
+	keywordsTokenMapName, ok := config["keywords_token_map"].(string)
+	if !ok {
+		return nil, fmt.Errorf("must specify keywords_token_map")
+	}
+	keywordsTokenMap, err := cache.TokenMapNamed(keywordsTokenMapName)
+	if err != nil {
+		return nil, fmt.Errorf("error building keyword marker filter: %v", err)
+	}
+	return NewKeyWordMarkerFilter(keywordsTokenMap), nil
+}
+
+func init() {
+	err := registry.RegisterTokenFilter(Name, KeyWordMarkerFilterConstructor)
+	if err != nil {
+		panic(err)
+	}
+}

analysis/token/keyword/keyword_test.go

@@ -0,0 +1,73 @@
+//  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 keyword
+
+import (
+	"reflect"
+	"testing"
+
+	"github.com/blevesearch/bleve/v2/analysis"
+)
+
+func TestKeyWordMarkerFilter(t *testing.T) {
+
+	inputTokenStream := analysis.TokenStream{
+		&analysis.Token{
+			Term: []byte("a"),
+		},
+		&analysis.Token{
+			Term: []byte("walk"),
+		},
+		&analysis.Token{
+			Term: []byte("in"),
+		},
+		&analysis.Token{
+			Term: []byte("the"),
+		},
+		&analysis.Token{
+			Term: []byte("park"),
+		},
+	}
+
+	expectedTokenStream := analysis.TokenStream{
+		&analysis.Token{
+			Term: []byte("a"),
+		},
+		&analysis.Token{
+			Term:    []byte("walk"),
+			KeyWord: true,
+		},
+		&analysis.Token{
+			Term: []byte("in"),
+		},
+		&analysis.Token{
+			Term: []byte("the"),
+		},
+		&analysis.Token{
+			Term:    []byte("park"),
+			KeyWord: true,
+		},
+	}
+
+	keyWordsMap := analysis.NewTokenMap()
+	keyWordsMap.AddToken("walk")
+	keyWordsMap.AddToken("park")
+
+	filter := NewKeyWordMarkerFilter(keyWordsMap)
+	ouputTokenStream := filter.Filter(inputTokenStream)
+	if !reflect.DeepEqual(ouputTokenStream, expectedTokenStream) {
+		t.Errorf("expected %#v got %#v", expectedTokenStream[0].KeyWord, ouputTokenStream[0].KeyWord)
+	}
+}