aboutsummaryrefslogtreecommitdiffstats
path: root/searchlib/src/main/java/com/yahoo/searchlib/ranking/features/fieldmatch/Field.java
blob: 3f711df4fdd86bb2b03c3c78925097373d4c9fc6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.searchlib.ranking.features.fieldmatch;

import java.util.Arrays;
import java.util.List;

/**
 * Represents a document field which can be matched and ranked against.
 *
 * @author bratseth
 */
public class Field {

    private final List<Term> terms;

    /** Creates a field from a space-separated string */
    public Field(String fieldString) {
        terms = Arrays.stream(fieldString.split(" ")).map(Term::new).toList();

    }

    /** Creates a field from a list of terms */
    public Field(List<Term> terms) {
        this.terms = List.copyOf(terms);
    }

    /** Returns an immutable list of the terms in this */
    public List<Term> terms() { return terms; }

    /** A term in a field */
    public static class Term {

        private final String value;
        private final float exactness;

        /** Creates a term with the given value and full exactness (1.0) */
        public Term(String value) {
            this(value, 1.0f);
        }

        public Term(String value, float exactness) {
            this.value = value;
            this.exactness = exactness;
        }

        /** Returns the string value of this term */
        public String value() { return value; }

        /**
         * Returns the degree to which this term is exactly what was in the document (1.0),
         * or some stemmed form (closer to 0)
         */
        public float exactness() { return exactness; }

    }

}