aboutsummaryrefslogtreecommitdiffstats
path: root/container-search/src/main/java/com/yahoo/prelude/query/SegmentItem.java
blob: dc2e98c372c3ce4e1f1efa1c398496c42ae39e1a (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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.prelude.query;


import com.yahoo.prelude.query.textualrepresentation.Discloser;

import java.util.Objects;


/**
 * An immutable and'ing of a collection of sub-expressions. It does not
 * extend AndItem to avoid code using instanceof handling it as an
 * AndItem.
 *
 * @author Steinar Knutsen
 */
public abstract class SegmentItem extends CompositeItem implements BlockItem {

    private boolean locked = false;
    private final String rawWord;
    private final String value;
    private final boolean isFromQuery;
    private boolean isFromUser;
    private final boolean stemmed;
    private SegmentingRule segmentingRule = SegmentingRule.LANGUAGE_DEFAULT;
    private final Substring origin;

    /**
     * Creates a new segment item
     *
     * @param rawWord the raw form of this segment as received in the request
     * @param current the current transformed version of the raw form, or the raw form repeated if no normalized form is known
     * @param isFromQuery whether this segment stems from the query received in the request
     * @param stemmed whether this is stemmed
     */
    public SegmentItem(String rawWord, String current, boolean isFromQuery, boolean stemmed) {
        this(rawWord, current, isFromQuery, stemmed, null);
    }

    /**
     * Creates a new segment item
     *
     * @param rawWord the raw form of this segment as received in the request
     * @param current the current transformed version of the raw form, or the raw form repeated if no normalized form is known
     * @param isFromQuery whether this segment stems from the query received in the request
     * @param stemmed whether this is stemmed
     * @param origin the original text that led to this
     */
    public SegmentItem(String rawWord, String current, boolean isFromQuery, boolean stemmed, Substring origin) {
        this.rawWord = rawWord;
        this.value = current;
        this.stemmed = stemmed;
        this.isFromQuery = isFromQuery;
        isFromUser = isFromQuery;
        this.origin = origin;
    }

    public String getRawWord() {
        return rawWord;
    }

    public String getNormalized() {
        return value;
    }

    @Override
    public String stringValue() {
        return value;
    }

    @Override
    public boolean isFromQuery() {
        return isFromQuery;
    }

    @Override
    public boolean isStemmed() {
        return stemmed;
    }

    public void lock() {
        locked = true;
    }

    public boolean isLocked() {
        return locked;
    }

    @Override
    public int getNumWords() {
        return getItemCount();
    }

    @Override
    public void addItem(Item item) {
        throwIfLocked();
        super.addItem(item);
    }

    @Override
    public void addItem(int index, Item item) {
        throwIfLocked();
        super.addItem(index, item);
    }

    @Override
    public Item removeItem(int index) {
        throwIfLocked();
        return super.removeItem(index);
    }

    public boolean removeItem(Item item) {
        throwIfLocked();
        return super.removeItem(item);
    }

    private void throwIfLocked() {
        if (locked)
            throw new IllegalStateException("Cannot change change an immutable segment");
    }

    // TODO: Add a getItemIterator which is safe for immutability

    /** Return a deep copy of this object */
    @Override
    public SegmentItem clone() {
        SegmentItem copy;
        synchronized(this) {
            boolean tmpLock = locked;

            locked = false;
            copy = (SegmentItem) super.clone();
            locked = tmpLock;
            copy.locked = tmpLock;
        }
        return copy;
    }

    @Override
    public boolean isWords() {
        return true;
    }

    public boolean isFromUser() {
        return isFromUser;
    }

    public void setFromUser(boolean isFromUser) {
        this.isFromUser = isFromUser;
    }

    /** Returns null right now */
    public Substring getOrigin() {
        return origin;
    }

    @Override
    public void disclose(Discloser discloser) {
        super.disclose(discloser);
        discloser.addProperty("isFromQuery", isFromQuery);
        discloser.addProperty("isFromUser", isFromUser);
        discloser.addProperty("locked", locked);
        discloser.addProperty("rawWord", rawWord);
        discloser.addProperty("stemmed", stemmed);
    }

    @Override
    public SegmentingRule getSegmentingRule() {
        return segmentingRule;
    }

    public void setSegmentingRule(SegmentingRule segmentingRule) {
        this.segmentingRule = segmentingRule;
    }

    @Override
    public boolean equals(Object o) {
        if ( ! super.equals(o)) return false;
        var other = (SegmentItem)o;
        if ( ! Objects.equals(this.rawWord, other.rawWord)) return false;
        if ( ! Objects.equals(this.value, other.value)) return false;
        if ( this.isFromQuery != other.isFromQuery) return false;
        if ( this.isFromUser != other.isFromUser) return false;
        if ( this.stemmed != other.stemmed) return false;
        if ( this.segmentingRule != other.segmentingRule) return false;
        if ( ! Objects.equals(this.origin, other.origin)) return false;
        return true;
    }

    @Override
    public int hashCode() {
        return Objects.hash(super.hashCode(), rawWord, value, isFromQuery, isFromUser, stemmed, segmentingRule, origin);
    }

}