facet

package

v0.0.30 Latest Latest Go to latest Published: Mar 29, 2024 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ohzqq/srch

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Filter(bits *roaring.Bitmap, fields []*Facet, filters []any) (*roaring.Bitmap, error)
func FilteredItems(data []map[string]any, ids []any) []map[string]any
func ItemsByBitmap(data []map[string]any, bits *roaring.Bitmap) []map[string]any
func SortByAlphaFunc(a *Item, b *Item) int
func SortByCountFunc(a *Item, b *Item) int
type Facet
- func NewFacet(attr string) *Facet
- func NewFacets(attrs []string) []*Facet
type Fields
- func New(data []map[string]any, param *param.Params) (*Fields, error)
- func NewFields(fields []string) *Fields
type Item

Constants ¶

View Source

const (
	SortByCount = `count`
	SortByAlpha = `alpha`
)

Variables ¶

This section is empty.

Functions ¶

func Filter ¶

func Filter(bits *roaring.Bitmap, fields []*Facet, filters []any) (*roaring.Bitmap, error)

func FilteredItems ¶

func FilteredItems(data []map[string]any, ids []any) []map[string]any

FilteredItems returns the subset of data.

func ItemsByBitmap ¶

func ItemsByBitmap(data []map[string]any, bits *roaring.Bitmap) []map[string]any

func SortByAlphaFunc ¶

func SortByAlphaFunc(a *Item, b *Item) int

func SortByCountFunc ¶

func SortByCountFunc(a *Item, b *Item) int

Types ¶

type Facet struct {
	Attribute string  `json:"attribute"`
	Items     []*Item `json:"items"`
	Count     int     `json:"count"`
	Sep       string  `json:"-"`

	SortBy string `json:"-"`
	Order  string `json:"-"`
	// contains filtered or unexported fields
}

func NewFacet ¶ added in v0.0.24

func NewFacet(attr string) *Facet

func NewFacets ¶

func NewFacets(attrs []string) []*Facet

func (f *Facet) Add(val any, ids []int)

func (f *Facet) Filter(val string) *roaring.Bitmap

func (f *Facet) Find(val any) []*Item

func (f *Facet) FindByIndex(ti ...int) []*Item

func (f *Facet) FindByLabel(label string) *Item

func (f *Facet) FindByValue(val string) *Item

func (f *Facet) Fuzzy(term string) *roaring.Bitmap

func (f *Facet) GetValues() []string

func (f *Facet) Keywords() []*Item

func (f *Facet) Len() int

Len returns the number of items, to satisfy the fuzzy.Source interface.

func (f *Facet) Search(term string) []*Item

func (f *Facet) SortTokens() []*Item

func (f *Facet) String(i int) string

String returns an Item.Value, to satisfy the fuzzy.Source interface.

func (f *Facet) Tokenize(val any) []*Item

type Fields ¶ added in v0.0.24

type Fields struct {
	Facets []*Facet `json:"facetFields"`
	// contains filtered or unexported fields
}

func New ¶

func New(data []map[string]any, param *param.Params) (*Fields, error)

func NewFields ¶

func NewFields(fields []string) *Fields

func (*Fields) Bitmap ¶ added in v0.0.24

func (f *Fields) Bitmap() *roaring.Bitmap

func (*Fields) Calculate ¶ added in v0.0.24

func (f *Fields) Calculate() *Fields

func (*Fields) Filter ¶ added in v0.0.24

func (f *Fields) Filter(filters []any) (*Fields, error)

func (Fields) GetFacet ¶ added in v0.0.24

func (f Fields) GetFacet(attr string) (*Facet, error)

func (*Fields) Items ¶ added in v0.0.24

func (f *Fields) Items() []string

func (Fields) Len ¶ added in v0.0.24

func (f Fields) Len() int

func (*Fields) MarshalJSON ¶ added in v0.0.24

func (f *Fields) MarshalJSON() ([]byte, error)

type Item ¶ added in v0.0.24

type Item struct {
	Value     string `json:"value"`
	Label     string `json:"label"`
	Count     int    `json:"count"`
	RelatedTo []int  `json:"relatedTo"`
	Children  *Facet `json:"-"`
	// contains filtered or unexported fields
}

func KeywordTokenizer ¶

func KeywordTokenizer(val any) []*Item

func NewItem ¶ added in v0.0.24

func NewItem(label string) *Item

func SortTokensByAlpha ¶

func SortTokensByAlpha(items []*Item) []*Item

func SortTokensByCount ¶

func SortTokensByCount(items []*Item) []*Item

func (*Item) Add ¶ added in v0.0.24

func (i *Item) Add(ids ...int)

func (*Item) Bitmap ¶ added in v0.0.24

func (i *Item) Bitmap() *roaring.Bitmap

func (*Item) Contains ¶ added in v0.0.24

func (i *Item) Contains(id int) bool

func (*Item) GetItems ¶ added in v0.0.24

func (i *Item) GetItems() []int

func (*Item) Len ¶ added in v0.0.24

func (i *Item) Len() int

func (*Item) SetValue ¶ added in v0.0.24

func (i *Item) SetValue(txt string) *Item

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL